Skip to content

Improved documentation structure and clarity in README.md #1899

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

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

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