Skip to content

Comments

docs: improve README with architecture, setup, and structure docs#107

Closed
Aaradhya-07 wants to merge 1 commit intom-lab:mainfrom
Aaradhya-07:docs/improve-readme
Closed

docs: improve README with architecture, setup, and structure docs#107
Aaradhya-07 wants to merge 1 commit intom-lab:mainfrom
Aaradhya-07:docs/improve-readme

Conversation

@Aaradhya-07
Copy link

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.

@Kunal1522
Copy link
Contributor

hi @Aaradhya-07 thanks for your interest in contributing ..but i think this would make more sense in contributing.md
there is already a pr regarding this #103 although the rest additions are very solid

@robertodauria
Copy link
Contributor

Thanks for the contribution. Closing this as #83 already addresses it. We aim to merge #83 next week, which will give contributors a stable, modern base to work from. We'd encourage you to review it and open any future PRs on top of that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants