You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When looking at a given section, it is not obvious to know whether a given command belongs to a parent group (and which one) (see subcommand1 and subcommand2), or if it's just a standalone command (see subcommand3).
Besides, permalinks only contain eg /#subcommand2, which again doesn't convey the actual hierarchy.
Suggested solution
Make headings contain the full command_path, eg ## root subgroup1 subcommand2
Permalinks should be updated too, eg /#root-subgroup1-subcommand2 (see custom labels)
TOC entries should not change, as the TOC already conveys the hierarchy just fine.
The text was updated successfully, but these errors were encountered:
Problem statement
Consider a nested CLI, ie one group with one or more nested commands or groups.
Right now the TOC looks like this:
This is nice and clean, as it allows visualizing the
But… In the page content itself, the hierarchy is only represented by heading styles (more or less big/bold text), like this:
When looking at a given section, it is not obvious to know whether a given
command
belongs to a parent group (and which one) (seesubcommand1
andsubcommand2
), or if it's just a standalone command (seesubcommand3
).Besides, permalinks only contain eg
/#subcommand2
, which again doesn't convey the actual hierarchy.Suggested solution
command_path
, eg## root subgroup1 subcommand2
/#root-subgroup1-subcommand2
(see custom labels)The text was updated successfully, but these errors were encountered: