Docs: Add quick local setup and common gotchas for new contributors #11856
+53
−15
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
Adds a short TL;DR local setup section and a list of common setup issues near the top of the README to help first-time contributors get started more quickly.
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.
Adds a short TL;DR "Quick Local Setup" section and a "Common Gotchas for First-Time Contributors" section near the top of the README.
This is intended to give new contributors a clear and minimal entry point to get the app running locally without having to read the full installation guide upfront. The existing detailed documentation remains unchanged and is referenced below for deeper setup steps.
Fixes #11855