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

Docs: Categorize Commands in Guide #2213

Merged
merged 10 commits into from
Oct 4, 2023

Conversation

nicholassaylor
Copy link
Contributor

@nicholassaylor nicholassaylor commented Sep 23, 2023

What is this fixing or adding?

  • Adds categories for commands
  • Re-orders commands by relevance
  • Swaps order of server commands and client commands
  • Moves game-specific commands into the game page (This change only moves Final Fantasy 1 and Factorio commands)

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.

One reservation I have at this point is the inclusion of the client-specific commands, such as those from FF1Client and FactorioClient. In its current state, the local commands for specific clients are out of date. However, I forsee this section getting increasingly hard to maintain as more games are added and we migrate to apworlds. I think the best idea at this point is to remove the specific commands from this guide and instead move them to the guides of those games.

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.

image
Server commands preview
image
Local commands preview

image
Example of commands in game page

@nicholassaylor nicholassaylor marked this pull request as ready for review September 23, 2023 00:52
@LegendaryLinux
Copy link
Member

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.

@LegendaryLinux
Copy link
Member

I do think SNI Client should remain on this page, as that is used in multiple games.

@eudaimonistic
Copy link
Contributor

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.

@nicholassaylor
Copy link
Contributor Author

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.

@LegendaryLinux
Copy link
Member

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.

@LegendaryLinux LegendaryLinux merged commit 6c4a395 into ArchipelagoMW:main Oct 4, 2023
7 checks passed
@nicholassaylor nicholassaylor deleted the categorize-commands branch October 8, 2023 21:43
@ThePhar ThePhar added the is: documentation Improvements or additions to documentation. label Oct 17, 2023
FlySniper pushed a commit to FlySniper/Archipelago that referenced this pull request Nov 14, 2023
* 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
Jouramie pushed a commit to Jouramie/Archipelago that referenced this pull request Feb 28, 2024
* 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
is: documentation Improvements or additions to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants