Add links to the start of the Quick Start Guide#18550
Merged
Merged
Conversation
Added links (like a mini table of contents) to the Quick start guide. I often refer people to this section when just starting out with NVDA, and while in some cases they may be at a particular point (Having already installed NVDA, or needing to acquire it), in others, it is unclear, so I wanted to make it easy to point them to the start of the Quick Start Guide but for them to readily be able to jump to the part they need.
Qchristensen
commented
Jul 25, 2025
Qchristensen
commented
Jul 25, 2025
Qchristensen
commented
Jul 25, 2025
seanbudd
reviewed
Jul 25, 2025
|
|
||
| This quick start guide contains three main sections: downloading, initial setup, and running NVDA. | ||
| These are followed by information on adjusting preferences, using add-ons, participating in the community and getting help. | ||
| This quick start guide contains three main sections: |
Member
There was a problem hiding this comment.
Should we make this caps for branding? Like we do for "User Guide" and "Changes"
Suggested change
| This quick start guide contains three main sections: | |
| This Quick Start Guide contains three main sections: |
Member
There was a problem hiding this comment.
I think title case when refering to the document itself ("The NVDA Quick Start Guide"), but sentence case when referring to the type of document ("a quick start guide"). So in this sentence, it would not be title-cased.
seanbudd
approved these changes
Jul 25, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Link to issue number:
N/A
Summary of the issue:
I often refer people to this section when just starting out with NVDA, and while in some cases they may be at a particular point (Having already installed NVDA, or needing to acquire it), in others, it is unclear, so I wanted to make it easy to point them to the start of the Quick Start Guide but for them to readily be able to jump to the part they need.
Description of user facing changes:
I added links (like a mini table of contents) to the start of the Quick start guide, to point to the anchors which already existed in the various headings in that section.
Description of developer facing changes:
N/A
Description of development approach:
Testing strategy:
Known issues with pull request:
Code Review Checklist:
@coderabbitai summary