Skip to content

Improve README formatting for better readability #10791

@0NIKHIL0

Description

@0NIKHIL0

Component

Documentation (README.md)

Is your proposal related to a problem?

The current README file contains all the necessary information but can be improved for clarity and readability.
Some sections have inconsistent spacing and formatting, which might make it harder for new users to follow the setup steps easily.

Describe the solution you'd like

I'd like to update the README.md file to:

  • Improve markdown formatting and spacing.
  • Make code examples easier to read.
  • Add small comments or clarifications where needed.

This will make the documentation look cleaner and more user-friendly.

Describe alternatives you've considered

Currently, no alternatives have been considered — updating the README directly seems the most efficient way to improve usability.

Metadata

Metadata

Assignees

No one assigned

    Labels

    k/enhancementNew feature or improve an existing feature

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions