Skip to content

Conversation

@Garimajunejaa
Copy link

@Garimajunejaa Garimajunejaa commented Aug 5, 2025

Description

Improved the documentation structure and clarity in README.md.

  • Reorganized installation steps under clearer headings.
  • Reformatted code blocks for better readability.
  • Added short explanations and consistent formatting across the file.

Motivation

The README is the first point of contact for new users. These changes enhance understanding and reduce confusion during setup, especially for first-time contributors.

Checklist

  • Code blocks are well-formatted
  • Headings follow consistent markdown structure
  • Content is easy to follow for new users

Related Issue

No specific issue linked — this is a general improvement.

@Garimajunejaa
Copy link
Author

Hi maintainers

I've improved the formatting and readability of the README.md file by restructuring the documentation and fixing inconsistencies.

Please let me know if any further changes are needed.

Thank you for the opportunity to contribute

Copy link

@wasup-yash wasup-yash left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As this does not belong to any major/minor roadmap docs change or issue ig it's irrelevent to change the dev docs.Thank you (not an official reviewer)

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.

2 participants