-
Notifications
You must be signed in to change notification settings - Fork 723
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
Conversation
Existing setup guide hard-coded in a YAML from 0.1.7
I'd prefer this just got completely removed as we have general guides that explain how to create yaml files and manually edit them. |
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. |
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. |
I would update the text after merging the text |
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.
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
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.
Thanks!
Existing setup guide hard-coded in a YAML from 0.1.7
Existing setup guide hard-coded in a YAML from 0.1.7
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.