-
-
Notifications
You must be signed in to change notification settings - Fork 783
Add table of contents to key commands and change log #16106
Copy link
Copy link
Closed
Labels
blocked/needs-product-decisionA product decision needs to be made. Decisions about NVDA UX or supported use-cases.A product decision needs to be made. Decisions about NVDA UX or supported use-cases.component/user-documentationgood first issuegithub features these at https://github.com/nvaccess/nvda/contributegithub features these at https://github.com/nvaccess/nvda/contributep5https://github.com/nvaccess/nvda/blob/master/projectDocs/issues/triage.md#priorityhttps://github.com/nvaccess/nvda/blob/master/projectDocs/issues/triage.md#priorityquick fixtriagedHas been triaged, issue is waiting for implementation.Has been triaged, issue is waiting for implementation.
Milestone
Description
Metadata
Metadata
Assignees
Labels
blocked/needs-product-decisionA product decision needs to be made. Decisions about NVDA UX or supported use-cases.A product decision needs to be made. Decisions about NVDA UX or supported use-cases.component/user-documentationgood first issuegithub features these at https://github.com/nvaccess/nvda/contributegithub features these at https://github.com/nvaccess/nvda/contributep5https://github.com/nvaccess/nvda/blob/master/projectDocs/issues/triage.md#priorityhttps://github.com/nvaccess/nvda/blob/master/projectDocs/issues/triage.md#priorityquick fixtriagedHas been triaged, issue is waiting for implementation.Has been triaged, issue is waiting for implementation.
Type
Fields
Give feedbackNo fields configured for issues without a type.
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