Montage README: WSL, OAuth, YAML, Troubleshooting#442
Open
Sanika123-art wants to merge 4 commits intohatnote:masterfrom
Open
Montage README: WSL, OAuth, YAML, Troubleshooting#442Sanika123-art wants to merge 4 commits intohatnote:masterfrom
Sanika123-art wants to merge 4 commits intohatnote:masterfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What has been changed?
Added Windows Subsystem for Linux (WSL) setup instructions for a smoother local development experience on Windows.
Added a step-by-step OAuth consumer setup guide for Meta-Wiki, including application name, callback URL, and required grants.
Provided an example config.dev.yaml file with properly formatted OAuth keys and callback URL.
Added a Troubleshooting section with a table covering common setup issues:
OAuthException (E010)
Invalid consumer key/secret
Callback URL mismatch
Dependency errors on Windows
Why is this change needed?
The current README is missing key instructions for new contributors, especially for Windows users.
This PR makes local development setup clearer, beginner-friendly, and less error-prone, reducing time spent troubleshooting OAuth and environment issues.
Issue Reference
Fixes #411