Skip to content

docs(README) - Update the README structure #356

@abhisheksr01

Description

@abhisheksr01

Description

Update the README structure so that it's more accessible and readable.
Provide better engagement with the readers, and update commands executed in the README.

Suggested Changes

The above can be achieved by making the following changes:

  • Refactor the README structure. This can be achieved in below ways:
    • Split the README into multiple markdown files (for example Affected Documentation list) and add a link in the README.
    • Use collapsable sections in the README to abstract the extra details
  • Update the README commands

Affected Documentation

  • README.md
  • API Documentation
  • Developer Guide
  • Setup Instructions
  • Contribution Guide
  • Other (please specify):

Additional Information

Example of the README structure:

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions