-
Notifications
You must be signed in to change notification settings - Fork 722
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: rework main ap setup guide #1853
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
General wording changes for grammar and clarity
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Couple points, but otherwise it's fine. Most of it does only apply to Windows however, so a note should be added somewhere about that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggested a few grammatical/wording adjustments
|
||
For connecting from the game to the server, the connection info is needed for any of the game clients. Games that use | ||
data files will usually contain the connection info within these files, when hosted on the Archipelago website. If the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this true? I know LttP does this, but do most/any others? I don't believe DKC3 or SMW do.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Factorio, OoT, SM, and Minecraft do. Not sure on some of the others, but I think a significant enough amount to use the term "usually".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good to me, only thing that needs to be done needs to change the references to using_website_en resource which will now all be dead links (including site map in footer)
worlds/overcooked2/docs/setup_en.md
worlds/soe/docs/multiworld_en.md
WebHostLib/templates/siteMap.html
Also you never added that Windows disclaimer I mentioned. :sadcat:
* rework main ap setup guide * review updates * add blurb about re-opening rooms and user-content * more review suggestions * remove dead links. Windows blurb
* rework main ap setup guide * review updates * add blurb about re-opening rooms and user-content * more review suggestions * remove dead links. Windows blurb
What is this fixing or adding?
Reverts using the website and the local software for using Archipelago back into a single guide, instead of assuming the user knows how to do things already. Renames it to "Getting Started" to help incentivize reading it before referring to the game specific guides. Adds a section detailing the website room layout and information, as well as describing all of the connection info fields for games that use it.
How was this tested?
📖
If this makes graphical changes, please attach screenshots.