Skip to content
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

docs(README) - Update the README structure #356

Open
5 of 6 tasks
abhisheksr01 opened this issue Dec 27, 2024 · 1 comment · Fixed by #363
Open
5 of 6 tasks

docs(README) - Update the README structure #356

abhisheksr01 opened this issue Dec 27, 2024 · 1 comment · Fixed by #363
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@abhisheksr01
Copy link
Owner

abhisheksr01 commented Dec 27, 2024

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:

@abhisheksr01 abhisheksr01 added the documentation Improvements or additions to documentation label Dec 27, 2024
@abhisheksr01
Copy link
Owner Author

abhisheksr01 commented Dec 28, 2024

Implementation Checklist:

  • Wrap all the extra content in the collapsable section to begin with
  • Rename the docs-resources to the docs directory
  • Split the README into multiple markdown files
  • Remove the HTML screenshot with actual HTML reports in the docs in the director

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
1 participant