-
Notifications
You must be signed in to change notification settings - Fork 723
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
Docs: Categorize Commands in Guide #2213
Docs: Categorize Commands in Guide #2213
Conversation
Commands re-ordered and put into categories Some commands were better documented / explained more clearly Other formatting changes
I'm torn. On the one hand, keeping all the information about individual client commands in one place is convenient. On the other hand, as we move into the APWorld format, each game will need to start documenting itself better anyway. I think I'm in favor of removing game-specific commands from this page and moving them to the specific game guides. |
I do think SNI Client should remain on this page, as that is used in multiple games. |
These changes seem to suit the generic commands far more than the game-specific commands. I agree that the game-specific commands should probably end up moved into their setup guide counterparts instead. I'm in favor of at least the Server Commands changes. |
I definitely agree with keeping the SNI commands in this guide since so many games use it. I suppose that if we wanted a central place for all game-specific commands, it could exist in its own separate guide. But in the end, it's just pushing the problem to a different part of the site without addressing the issue. I will move the specific commands into their respective game pages and leave the SNIClient commands as they are. |
I don't like the idea of a standalone guide to contain client specific commands. They should go in their own game's guide. A standalone page just de-centralizes information. All relevant information about a game and its client should be available in that game's guide. |
* Update commands_en.md Commands re-ordered and put into categories Some commands were better documented / explained more clearly Other formatting changes * Status command moved to General category and elaboration on getitem command * "Multi-world" -> "Multiworld" * Moved game-specific local commands to game pages
* Update commands_en.md Commands re-ordered and put into categories Some commands were better documented / explained more clearly Other formatting changes * Status command moved to General category and elaboration on getitem command * "Multi-world" -> "Multiworld" * Moved game-specific local commands to game pages
What is this fixing or adding?
The main purpose of this pull request is to help organize the commands better so that users can easily find the commands they need.
Server commands were put first since they tend to be the commands that are used the most often. Commands were then put into categories based on their function.
Local commands were updated to better reflect which clients allow the use of the common local commands.
Addressed in af9237f
However, I would like to hear input on this matter.
How was this tested?
Running webhost and viewing rendered changes
If this makes graphical changes, please attach screenshots.
Server commands preview
Local commands preview
Example of commands in game page