Docs, WebHost: Update faq_en.md #2313
Conversation
Reorganizing information and adding links to some of the various guides and website pages. Even just adding the Getting Started, Supported Games, and Server Commands links seems like a hefty upgrade. We have good resources, we should make them obvious. I think more can probably be done here, but I already shuffled this around a lot.
|
I would probably reorganize things some more. Maybe something like:
|
|
Also I think multi world and multi game are very similar, and we might not need both? |
|
I think the distinction on multi-world vs multi-game adds value to someone unfamiliar with us and why we have both terms in the software description |
|
The way I see it, is the FAQ page is very likely a place people would land when they first get to the website. There are many entry points to learning about this platform. Quite a few users only know about us because of a single randomizer mod, completely unaware that we're a multiworld/multigame platform. It helps to explain the concepts separately because they might be completely foreign to new users. |
|
That makes sense. Any opinions on reorganizing? |
|
I do think I like your order a little better Sneaki. Smaller concepts to more specific ones |
ScootyPuffJr1
added
the
is: documentation
ThePhar
added
the
affects: webhost
Sneaki's suggestion makes way more sense organizationally. Added more detail to the single player section to more clearly explain the easiest method.
That organization makes way more sense. I arranged as suggested, and elaborated a little more on single player while doing a pass. |
|
I think I disagree with this, only because the word is not hyphenated on the main page of the website |
|
it’s very inconsistent throughout the site. In this file specifically it’s all multi-world. There is another multiworld on |
|
Better change them all to "multiworld" then, which should be the preferred spelling of the noun. |
Consistency Co-authored-by: kindasneaki <[email protected]>
More consistency Co-authored-by: kindasneaki <[email protected]>
|
...Imagine making commits without reading the entire chain... Anyway, will recommit with explicitly using multiworld as a noun. |
Makes more sense and is colloquially the preferred terminology.
|
I've chosen to keep the usage of multi-game hyphenated, because it's probably good to articulate it differently than multiworld for natural emphasis. When reading multi-game as a hyphenated term, it implies a modification to the combined noun multiworld. In this context, I think it works better that way. |
|
I think that's for the best - the main page also shows it as multi-game |
Changed the "What if a player needs to leave early" section into, "Does everyone need to be connected at the same time?" This allows the FAQ to explain briefly what a sync multiworld and an async multiworld is. This is probably good material for the Glossary, but it comes up so much in the Discord that we probably need to explain it here as briefly as possible. This paragraph lends itself to the question of what to do if a player must leave early anyway.
|
I've reworked the section about leaving early and turned it into a basic explanation of sync/async, so as to clarify the general flow of a multiworld. This comes up constantly in the Discord and it seems necessary to explain here. While I can foresee more improvements being possible beyond this point, we seem to be growing fast enough to warrant pushing this through and revisiting the page at a later date if necessary. |
|
@LegendaryLinux as the original author, I think. |
…ges I originally authored.
|
Better English than mine prevails. I approve of those changes. |
* Update faq_en.md Reorganizing information and adding links to some of the various guides and website pages. Even just adding the Getting Started, Supported Games, and Server Commands links seems like a hefty upgrade. We have good resources, we should make them obvious. I think more can probably be done here, but I already shuffled this around a lot. * Reorganize information again, elaborate single player Sneaki's suggestion makes way more sense organizationally. Added more detail to the single player section to more clearly explain the easiest method. * Usage of multi-world Consistency Co-authored-by: kindasneaki <[email protected]> * More multi-world More consistency Co-authored-by: kindasneaki <[email protected]> * Revert to multiworld Makes more sense and is colloquially the preferred terminology. * Rework "leaving early" Changed the "What if a player needs to leave early" section into, "Does everyone need to be connected at the same time?" This allows the FAQ to explain briefly what a sync multiworld and an async multiworld is. This is probably good material for the Glossary, but it comes up so much in the Discord that we probably need to explain it here as briefly as possible. This paragraph lends itself to the question of what to do if a player must leave early anyway. * Grammatical, tensing, and voice updates for consistency with other pages I originally authored. --------- Co-authored-by: kindasneaki <[email protected]> Co-authored-by: Chris Wilson <[email protected]>
* Update faq_en.md Reorganizing information and adding links to some of the various guides and website pages. Even just adding the Getting Started, Supported Games, and Server Commands links seems like a hefty upgrade. We have good resources, we should make them obvious. I think more can probably be done here, but I already shuffled this around a lot. * Reorganize information again, elaborate single player Sneaki's suggestion makes way more sense organizationally. Added more detail to the single player section to more clearly explain the easiest method. * Usage of multi-world Consistency Co-authored-by: kindasneaki <[email protected]> * More multi-world More consistency Co-authored-by: kindasneaki <[email protected]> * Revert to multiworld Makes more sense and is colloquially the preferred terminology. * Rework "leaving early" Changed the "What if a player needs to leave early" section into, "Does everyone need to be connected at the same time?" This allows the FAQ to explain briefly what a sync multiworld and an async multiworld is. This is probably good material for the Glossary, but it comes up so much in the Discord that we probably need to explain it here as briefly as possible. This paragraph lends itself to the question of what to do if a player must leave early anyway. * Grammatical, tensing, and voice updates for consistency with other pages I originally authored. --------- Co-authored-by: kindasneaki <[email protected]> Co-authored-by: Chris Wilson <[email protected]>
Reorganizing information and adding links to some of the various guides and website pages. Even just adding the Getting Started, Supported Games, and Server Commands links seems like a hefty upgrade. We have good resources, we should make them obvious.
I think more can probably be done here, but I already shuffled this around a lot. Would appreciate suggestions or feedback.