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
Restore numbering for TOC, add TOC to keyCommands #16226
Conversation
See test results for failed build of commit 7f27720d43 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Assuming this works okay with rtl, then this looks okay to me.
One thing just to note though is that in comparison with the 2023.3 user guide, the numbers in the table of contents now appear in place of the bullets, rather than inside the links. I don't necessarily have an issue with this, but just pointing it out.
@michaelDCurran - I've fixed RTL languages for the TOC, unfortunately there is unexpected behaviour for arabic-indic numbers when using |
This could easily be fixed if it's a better idea. I might run it by quentin as there is a visual difference, I find keeping it out of the link tag visually nicer but it's definitely a preference thing |
See test results for failed build of commit 3e8de111e5 |
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.
Link to issue number:
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.
Description of development approach
Testing strategy:
Generated docs and compared to 2023.3 documentation for english and arabic.
Compared dev guide, changes, key commands and the user guide.
Known issues with pull request:
None
Code Review Checklist: