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): #356 use collapsable section to improve readability #363

Merged
merged 2 commits into from
Dec 28, 2024

Conversation

abhisheksr01
Copy link
Owner

@abhisheksr01 abhisheksr01 commented Dec 28, 2024

Description

This PR does the following:

  • Use the collapsable section to make the documentation readable
  • Rename the doc-resources dir to docs to keep it in line with GitHub Repostructor recommendations

Affected Documentation

Link to GitHub Issue: #356

Affected Documentation:

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

How Has This Been Tested?

Please describe how the changes to the documentation were reviewed. If applicable, include instructions on how to view or
test the updated documentation.

  • Documentation preview checked in markdown renderer
  • Links and images tested for correctness

Checklist for Author

  • The PR follows below contribution conventions
    • PR title follows conventional commits format commit_type(
      scope): issue_reference message
    • PR commits follow conventional commits format commit_type(
      scope): issue_reference message
    • PR branch follows the convention of format [commit_type]-[issue-reference]-[brief-description]
  • My code follows the style guidelines of this project
  • I have performed a self-review of my documentation to reflect the code changes, spelling and is accurate
  • I have tested the documentation for correctness and if required added shreds of evidence (e.g., links, images)
  • My changes generate no new warnings or errors
  • Checks for unused files
  • Checks for changes not related to this issue

Additional notes for the reviewer

Checklist for Reviewer

  • The PR follows contribution guidelines
  • Reviewed documentation for accuracy and rendering

@abhisheksr01 abhisheksr01 force-pushed the docs-356-collapsable-section branch 11 times, most recently from bd1b67c to c0cf4bd Compare December 28, 2024 14:48
@abhisheksr01 abhisheksr01 force-pushed the docs-356-collapsable-section branch from c0cf4bd to dbeb2ea Compare December 28, 2024 14:58
@abhisheksr01 abhisheksr01 marked this pull request as ready for review December 28, 2024 15:10
@abhisheksr01 abhisheksr01 added the documentation Improvements or additions to documentation label Dec 28, 2024
@abhisheksr01 abhisheksr01 linked an issue Dec 28, 2024 that may be closed by this pull request
6 tasks
@abhisheksr01 abhisheksr01 merged commit 627a8e6 into main Dec 28, 2024
15 checks passed
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
Development

Successfully merging this pull request may close these issues.

docs(README) - Update the README structure
1 participant