Command naming convention in the TOC #2424
Unanswered
waldekmastykarz
asked this question in
Q&A
Replies: 1 comment
-
Makes sense for the |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
It seems like we have an inconsistent way of listing commands in the Table of Contents in our docs:
If you look at the first three commands in the CLI group, we list just their name, without anything else, eg. we say
consent
and notcli consent
. On the other hand, in thecompletion
group, we prefix each name with the group name, eg.completion clink update
. From the consistency point of view, shouldn't we useclink update
instead as the group is indicated by the parent group? Dropping the group name from the TOC would not only shorten the display name but improve readability as you could more easily lookup the necessary command without having to continuously skip the first part.What do you think?
Beta Was this translation helpful? Give feedback.
All reactions