docs: improve README with architecture, setup, and structure docs#107
Closed
Aaradhya-07 wants to merge 1 commit intom-lab:mainfrom
Closed
docs: improve README with architecture, setup, and structure docs#107Aaradhya-07 wants to merge 1 commit intom-lab:mainfrom
Aaradhya-07 wants to merge 1 commit intom-lab:mainfrom
Conversation
Contributor
|
hi @Aaradhya-07 thanks for your interest in contributing ..but i think this would make more sense in contributing.md |
Contributor
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
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.
The current setup instructions are a flat bullet list that's easy to miss steps in. This PR restructures the "Setting up Local Development Environment" section into three clear subsections — Requirements, Installation, and Running Locally — each with its own code blocks and links to the relevant tools. All other sections of the README (intro, adding languages, deployment) are preserved unchanged.