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

[DarylHorton-Docs] Add Collapsed Sections to Improve README Readability #372

Open
Daryl-Horton opened this issue Nov 24, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@Daryl-Horton
Copy link
Contributor

Is your feature request related to a problem? Please describe.
Hi, I'm a new contributor and I noticed the README file is quite long, making moving between sections a bit difficult.

Describe the solution you'd like
To enhance the readability and navigation of the README file, we should add collapsed sections for detailed or supplementary information. This will allow users to easily access the most important information without feeling overwhelmed by the content. If it's agreeable to the team, I'd like to add collapsed sections to the README file based on the primary headers in the table of contents.

Describe alternatives you've considered
None

Additional context
CollapsedSections

@Daryl-Horton Daryl-Horton added the enhancement New feature or request label Nov 24, 2024
@lostintangent
Copy link
Owner

This feedback makes sense and I'd appreciate a PR if you have the time to send one. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants