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
Add table of contents to key commands and change log #16106
Comments
more feedback here from the community would be appreciate before proceeding |
Regarding key commands, I have no strong opinion. But I agree that this document's organization may not be obvious and that the table of content may help here. Regarding the Change log, I am rather opposed to add it a table of content. The vast majority want to see the changes of the last version. Today that's the first text they read when they open the document; with a table of content, they will have to find the interesting information further, either going down with downArrow, quick navigating with "H" or pressing the first or second link of the table of content. |
I don't have any more feedback on this, and to some extent I think it's redundant. |
@seanbudd I agree with @CyrilleB79, adding a table of contents in changelog may not be a good idea because it will get longer with each new version and people may be less interested in reading it if they are not comfortable with that kind of system. I think it's better to leave it as it is. |
Fixes #16059 Closes #16106 Summary of the issue: Due to markdown limitations, numbered headings and a numbered table of contents was removed from the user and dev guide when migrating from t2t to markdown. However, these can be restored with CSS. Description of user facing changes Restores numbered headings to the table of contents and the headings within the user guide and developer guide. Added TOC to key commands guide. Numbered heading are avoided as they don't match the user guide and may be misleading.
Fixes nvaccess#16059 Closes nvaccess#16106 Summary of the issue: Due to markdown limitations, numbered headings and a numbered table of contents was removed from the user and dev guide when migrating from t2t to markdown. However, these can be restored with CSS. Description of user facing changes Restores numbered headings to the table of contents and the headings within the user guide and developer guide. Added TOC to key commands guide. Numbered heading are avoided as they don't match the user guide and may be misleading.
Is your feature request related to a problem? Please describe.
As a user it can be challenging to navigate the key commands guide, there is no clear document outline.
The change log is a bit unique - unlike the user guide or the key commands, most people expect to read from top to bottom, usually just checking the latest entry.
However, it would be handy to easily jump to a given years API changes for example, or just check the new feature for recent releases.
The table of contents would still allow easy jumping to the first entry.
Describe the solution you'd like
Add table of contents to key commands and change log
Describe alternatives you've considered
Leave as-is, only have a table of contents for the user guide and developer guide
Additional context
The text was updated successfully, but these errors were encountered: