Skip to content

[FEATURE]: Improve README navigation and contribution guidance #40

@NishuRajput12

Description

@NishuRajput12

Feature and its Use Cases

Feature Description

I would like to propose improvements to the README file to enhance navigation, readability, and documentation best practices.

Proposed Improvements

  • Add a Table of Contents for easier navigation
  • Convert absolute GitHub links to relative links
  • Add a "How to Contribute to This Repository" section
  • Improve minor consistency in document naming

Use Cases and Benefits

  • Helps new contributors quickly navigate the document
  • Makes documentation cleaner and more maintainable
  • Follows standard open-source documentation practices
  • Improves overall professionalism of the repository

This would mainly benefit new contributors, GSoC applicants, and community members who rely on the README for guidance.

Additional Context

These changes do not modify policies, only improve structure and usability.

I would like to work on this feature and submit a pull request.

Code of Conduct

  • I have joined the Discord server and will post updates there
  • I have searched existing issues to avoid duplicates

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions