gistpad icon indicating copy to clipboard operation
gistpad copied to clipboard

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

Open Daryl-Horton opened this issue 1 year ago • 1 comments

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 avatar Nov 24 '24 19:11 Daryl-Horton

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

lostintangent avatar Feb 16 '25 19:02 lostintangent

Closing this for now since I haven't heard this feedback from others. That said, I'll gladly accept a PR if someone can send it. Thanks!

lostintangent avatar Jun 10 '25 17:06 lostintangent