Skip to content

docs: enhance README by fixing grammar and adding beginner-friendly s…#1445

Open
anandvaidya21 wants to merge 1 commit intostreamlit:mainfrom
anandvaidya21:patch-1
Open

docs: enhance README by fixing grammar and adding beginner-friendly s…#1445
anandvaidya21 wants to merge 1 commit intostreamlit:mainfrom
anandvaidya21:patch-1

Conversation

@anandvaidya21
Copy link
Copy Markdown

📚 Context

This change improves the documentation by fixing minor grammar issues and adding helpful beginner setup tips. It aims to make the onboarding process smoother for new contributors.

🧠 Description of Changes

  • Fixed minor grammar and sentence clarity issues in the README
  • Added a "Beginner Tips" section under the Building/setup instructions
  • Improved overall readability and consistency

Current:

No UI changes (documentation update only)

Revised:

Added a new "Beginner Tips" section to assist new contributors during setup

💥 Impact

Size:

  • Small
  • Not small

🌐 References

  • Notion

…etup tips

Added beginner tips for setting up the environment.
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.

1 participant