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, OOT: Update YAML Creation Instructions for OoT #1745

Merged
merged 2 commits into from
Oct 27, 2023
Merged

Docs, OOT: Update YAML Creation Instructions for OoT #1745

merged 2 commits into from
Oct 27, 2023

Conversation

ArashiKurobara
Copy link
Contributor

What is this fixing or adding?

Per a tech support thread in Discord, the OoT guide turned out to have had a 0.1.7 yaml hard-coded in as a suggested example. I borrowed the verbiage from the SMZ3 setup guide, as that seemed like a particularly good sample.

Only covers the English version of the setup guide; Spanish and French appear to have the same issue but I would not be able to translate the instructions.

How was this tested?

This only changes a documentation .md file and as such was tested with the preview on the GitHub web editor.

If this makes graphical changes, please attach screenshots.

Existing setup guide hard-coded in a YAML from 0.1.7
@alwaysintreble
Copy link
Collaborator

I'd prefer this just got completely removed as we have general guides that explain how to create yaml files and manually edit them.

@ArashiKurobara
Copy link
Contributor Author

Yeah, I certainly don't have any strong feelings either way on that, just figured most of the other setup guides have it and either way the ancient one's gotta go.

@Berserker66
Copy link
Member

@espeon65536

@ThePhar ThePhar changed the title Update YAML Creation Instructions for OoT Docs, OOT: Update YAML Creation Instructions for OoT May 31, 2023
@ThePhar ThePhar added the is: documentation Improvements or additions to documentation. label May 31, 2023
@espeon65536
Copy link
Collaborator

I would like if we could ping the authors of the non-English guides to see if we can get those updated. Other than that, the update is fine.

@black-sliver
Copy link
Member

@TheLynk @Edos512

@TheLynk
Copy link
Contributor

TheLynk commented Sep 23, 2023

I would update the text after merging the text

Copy link
Contributor

@BootsinSoots BootsinSoots left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removes what it needs to. I think I like calling the file a config file and specifying the file extension, that's a little easier for the average user to understand what they are doing. It makes more intuitive sense

Copy link
Member

@black-sliver black-sliver left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@black-sliver black-sliver merged commit 6a24074 into ArchipelagoMW:main Oct 27, 2023
FlySniper pushed a commit to FlySniper/Archipelago that referenced this pull request Nov 14, 2023
Existing setup guide hard-coded in a YAML from 0.1.7
Jouramie pushed a commit to Jouramie/Archipelago that referenced this pull request Feb 28, 2024
Existing setup guide hard-coded in a YAML from 0.1.7
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.

8 participants