Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fall/Winter 2024 Major Docs Update #46

Open
StephenDaDev opened this issue Oct 3, 2024 · 1 comment
Open

Fall/Winter 2024 Major Docs Update #46

StephenDaDev opened this issue Oct 3, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@StephenDaDev
Copy link
Member

A current list of all planned updates to our documentation for the Fall/Winter of 2024. It has been quite a while since we last released an update, and some pages especially are starting to show their age. Currently, my goal is to be all done sometime early November. Below, and commented is a list of the various changes that are planned. Please if you know of anything at all that should be added, removed, or deleted, add it below. Even if you aren't sure still add it and we can discuss. Thanks!

(Please also do not be afraid to object to any changes proposed.)

@StephenDaDev StephenDaDev added the documentation Improvements or additions to documentation label Oct 3, 2024
@StephenDaDev StephenDaDev self-assigned this Oct 3, 2024
@StephenDaDev
Copy link
Member Author

StephenDaDev commented Oct 3, 2024

Installation

  • Raspberry Pi (new page - additional package installation required from normal Ubuntu)
  • Windows (update - need to enable view file extensions to rename a file to .env in GUI)
  • Windows (update - need to change to use .env.example and rename instead of making a new file - prevents user mistake)
  • Pterodactyl (migration - from Supporter's guide with their permission)
  • Windows (update - mention the ability to use WSL which usually yields better results when used)
  • Setting up auto restart (move - should be in Installation, not on its own)

Choosing a Host

  • Unrecommended Host Lists (new page - list of hosts that are extremely problematic, and not recommended)
  • Recommended Host Lists (new page - list of hosts that we and our community have had lots of luck with)
  • Choosing a host (new page - discuss considerations when choosing a host for your bot)

Old Docs

  • OLD DOCS (delete - updating page - no longer relevant)
  • OLD DOCS (update - merge FAQ)
  • OLD DOCS (update - move config vars & color names to Utilities category)
  • OLD DOCS (delete items that are no longer relevant)

General User Friendliness

  • Troubleshooting Guide (new page - steps to troubleshoot with logs content of frequent issues and how to resolve)
  • FAQ (update - include questions from in server FAQ and link to troubleshooting guide
  • Main Page (update - new example Loglink to demonstrate all features of the logviewer)
  • Getting Started Guide (new page - for USERS of a bot, not those deploying it, explaining basics of using the bot, and some configuration items)
  • Plugins (new page - include all plugins from the plugin list, maybe provide opportunity for plugin devs to have a page to use as docs for their bot?)

@StephenDaDev StephenDaDev pinned this issue Oct 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

When branches are created from issues, their pull requests are automatically linked.

1 participant