Restructure README: replace nested collapsible sections with flat headings and TOC#1219
Open
dadigu wants to merge 1 commit intomas-cli:mainfrom
Open
Restructure README: replace nested collapsible sections with flat headings and TOC#1219dadigu wants to merge 1 commit intomas-cli:mainfrom
dadigu wants to merge 1 commit intomas-cli:mainfrom
Conversation
…eadings and TOC Replaces deeply nested <details>/<summary> sections with standard markdown headings and a table of contents for easier navigation and discoverability. Addresses mas-cli#1061
|
Member
|
Thanks for the PR. How's this as a compromise solution: Keep all top-level accordions expanded by default, but all lower-level accordions collapsed by default. Provide pairs of buttons to the right (or left) of each accordion:
One additional expand/collapse button pair would be above (and possibly one pair would be below) the top-level accordions to expand/collapse all accordions. It would probably be useful to indent the titles (summaries) of each accordion according to its hierarchical depth enough so that its depth would be readily apparent. Would you be able & willing to implement that? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.



Summary
<details>/<summary>sections with standard markdown headingsAddresses #1061
Motivation
The current README nests content up to 3 levels deep in collapsible sections, which makes it difficult to:
New users may miss important sections like "Root privileges" or "Known Issues" entirely because they're hidden behind nested toggles.
A flat heading structure with a TOC provides the same "jump to what you need" navigation without hiding content by default. Readers can still scan quickly via the TOC, and GitHub's built-in heading anchors make deep linking work naturally.
Changes
<details>/<summary>wrappers##/###/####markdown headings