Skip to content

Update README.md#356

Open
Nitya-003 wants to merge 2 commits intoCode-A2Z:mainfrom
Nitya-003:main
Open

Update README.md#356
Nitya-003 wants to merge 2 commits intoCode-A2Z:mainfrom
Nitya-003:main

Conversation

@Nitya-003
Copy link

@Nitya-003 Nitya-003 commented Dec 19, 2025

Closes #355

Describe the add-ons or changes you've made 📃

This PR enhances the overall README documentation to improve onboarding and clarity for new contributors and first-time users.

Key improvements include:

  • Added a clear Getting Started section with setup steps and prerequisites
  • Introduced a Project Architecture overview explaining major modules like automation, authentication, admin tools, and AI models
  • Included example use cases and commands to help users understand Jarvis functionality
  • Improved contribution guidelines and PR expectations for open-source contributors (GSSoC, Hacktoberfest, IWOC, etc.)
  • Fixed Markdown & HTML rendering issues to ensure badges and sections display correctly on GitHub

These changes make the repository more beginner-friendly and contributor-ready.


Working Video 📷

Not applicable, as this PR focuses on documentation improvements only.


Type of change ☑️

What sort of change have you made:

  • Bug fix
  • New feature
  • Code style update (formatting, local variables)
  • Documentation update
  • Database update

Note to reviewers 📄

This PR does not affect application logic or functionality.
All changes are documentation-only and aimed at improving contributor experience and readability.
Please review the README structure and content for clarity and completeness.

@github-actions
Copy link

Thank you for submitting your pull request! We'll review it as soon as possible. For further communication, join our discord server https://discord.gg/tSqtvHUJzE.

@Avdhesh-Varshney
Copy link
Collaborator

image

@Nitya-003 You have distort the typography styling in headings as well as bullet points.

And in-proper heading elements used.
Please improve, I'll merge.

@Nitya-003
Copy link
Author

@Avdhesh-Varshney Check now or Please explain me what is required? and Please label it under SWOC.

@Avdhesh-Varshney
Copy link
Collaborator

@Nitya-003 Sorry but this repo is not part of swoc'26 and PR created earlier than 1 jan are not counted in swoc'26

Please improve the getting started section as well and revert the open-source programs section as well.

From next time, Never commit directly into main branch.

@Nitya-003
Copy link
Author

@Avdhesh-Varshney Ok I will

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.

Improve Project Documentation & Contributor Onboarding

2 participants