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: Guides out of date in multiple languages #2295

Open
8 of 28 tasks
BootsinSoots opened this issue Oct 11, 2023 · 6 comments
Open
8 of 28 tasks

DOCS: Guides out of date in multiple languages #2295

BootsinSoots opened this issue Oct 11, 2023 · 6 comments
Labels
is: documentation Improvements or additions to documentation.

Comments

@BootsinSoots
Copy link
Contributor

BootsinSoots commented Oct 11, 2023

What task needs to be completed?

MrPokemon11 went through the guides today after noticing errors in non-english guides. He produced the following list (acceptable guides removed). I also just noticed that PoryGone opened #1061 about just this thing here.

-Advanced settings

-Triggers guide

  • Seems fine, maybe include that it fully overwrites the option it changes?

-Plando guide

  • add OoT to list of games that have connection plando

-Adventure

  • Has two sections labeled "Multiworld Setup Guide" on the main tutorial page, except one is in french
    otherwise seems fine

-Clique

  • no comment

-DS3

-DKC3

  • I don't think including the instructions on how to host is necessary for this guide as it's covered elsewhere

-Factorio

  • wordy, may be confusing to new people (certainly was to me when i was setting it up)

-FF1

  • Add something that says to write down what the slot name is, considering how easily it can be lost

-HK

-KH2

-ALttP

  • Docs: (Re)write french alttp setup guide and game page #2296 Completely rewrite the french and
  • spanish translations, they're 2+ years out of date
  • deutsch translation needs refurbishment (installation section especially imo)
  • (MSU-1) discrepancy between english and spanish/french tutorial
  • (Plando) use a different phrase than "throws a coin" (under the sewer image)
  • (OOF replacement) i have no idea if this is still possible, someone else look at it

-Minecraft

-SoE

  • The A in "page" under "where do i get a config file?" is capitalized when it shouldnt be
  • Probably needs some refurbishment

-SMZ3

  • Probably needs refurbishment

-SM

  • Has macintosh setup been figured out yet? if so add it
  • Seems fine, I do recommend refurbishment

-Undertale

  • I recommend improving the readability of the tutorial, otherwise it seems fine

-Witness

@Silvris
Copy link
Collaborator

Silvris commented Oct 11, 2023

Oof replacement was introduced in 0.4.1, so I would be shocked if it managed to be out-of-date that quickly.
Additionally #2119 already has to update the plando guide, so I updated that while at it. I'll split that portion out into a separate docs PR so it can be merged without the additional baggage. I think there might be an argument for replacing the listing of games with "For certain supported games" or something to that extent, as the list of games that supports connections plando grows.

@BootsinSoots
Copy link
Contributor Author

BootsinSoots commented Oct 12, 2023

Let me know when you do so I can link it here. I suppose I probably shouldn't mark these as checked with the PRs not merged

@ShinyNT
Copy link
Contributor

ShinyNT commented Oct 12, 2023

regarding the Adventure point, I brought it up on the #archipelago-dev discord channel because it isn't necessarily something that needs to be corrected
tl;dr there isn't a clear standard on how that should be dealt with, either collapsing the Adventure section to follow the other guides format, or uncollapse eveything else so each guide can have a tittle in their own language

https://discord.com/channels/731205301247803413/731214280439103580/1161808319892160553 link to the discussion for those interested

(it's an easy fix regardless, the best for now is to determine a standard between all guides)

@nicholassaylor
Copy link
Contributor

Took a look into the DS3 documentation and saw that the red text was present in both languages. Looking at the doc using a Protanopia filter (the colorblindness most relevant here), the text looks as such.
image

Playing around with values using the WCAG guidelines provided within the accessibility tab of most web browser dev tools, the best value I could get was essentially identical to that of the link colors. While this might cause confusion for some people, it may be the best choice for making this text accessible. However, I would like more input on this topic.

@BootsinSoots
Copy link
Contributor Author

Wow, that is pretty invisible, huh? If it has to be a specific blue, then I guess that's the way to go. I'm not familiar with tools for checking against potential colorblindness issues

BootsinSoots added a commit to BootsinSoots/Archipelago that referenced this issue Oct 15, 2023
BootsinSoots added a commit to BootsinSoots/Archipelago that referenced this issue Oct 15, 2023
Added suggested change regarding BK mode from Issue ArchipelagoMW#2295
@ThePhar ThePhar added the is: documentation Improvements or additions to documentation. label Oct 17, 2023
black-sliver added a commit that referenced this issue Oct 22, 2023
* Added Note Explaining BK

Added suggested change regarding BK mode from Issue #2295

* Changed to Glossary hyperlink

* Fix minor typo in exclude_locations

* Update worlds/generic/docs/advanced_settings_en.md

Co-authored-by: kindasneaki <[email protected]>

* Docs: Reformat advanced_settings_en/progression_balancing

---------

Co-authored-by: kindasneaki <[email protected]>
Co-authored-by: black-sliver <[email protected]>
@Marechal-L
Copy link
Collaborator

In DS3, the french setup guide is missing downpatching instructions.
I'll provide a PR to translate it

FlySniper pushed a commit to FlySniper/Archipelago that referenced this issue Nov 14, 2023
…hipelagoMW#2316)

* Added Note Explaining BK

Added suggested change regarding BK mode from Issue ArchipelagoMW#2295

* Changed to Glossary hyperlink

* Fix minor typo in exclude_locations

* Update worlds/generic/docs/advanced_settings_en.md

Co-authored-by: kindasneaki <[email protected]>

* Docs: Reformat advanced_settings_en/progression_balancing

---------

Co-authored-by: kindasneaki <[email protected]>
Co-authored-by: black-sliver <[email protected]>
Jouramie pushed a commit to Jouramie/Archipelago that referenced this issue Feb 28, 2024
…hipelagoMW#2316)

* Added Note Explaining BK

Added suggested change regarding BK mode from Issue ArchipelagoMW#2295

* Changed to Glossary hyperlink

* Fix minor typo in exclude_locations

* Update worlds/generic/docs/advanced_settings_en.md

Co-authored-by: kindasneaki <[email protected]>

* Docs: Reformat advanced_settings_en/progression_balancing

---------

Co-authored-by: kindasneaki <[email protected]>
Co-authored-by: black-sliver <[email protected]>
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

No branches or pull requests

6 participants