Skip to content

Add links to the start of the Quick Start Guide#18550

Merged
SaschaCowley merged 5 commits into
masterfrom
QuickstartLinksBranch
Jul 25, 2025
Merged

Add links to the start of the Quick Start Guide#18550
SaschaCowley merged 5 commits into
masterfrom
QuickstartLinksBranch

Conversation

@Qchristensen
Copy link
Copy Markdown
Member

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:

  • Documentation:
    • Change log entry
    • User Documentation
    • Developer / Technical Documentation
    • Context sensitive help for GUI changes
  • Testing:
    • Unit tests
    • System (end to end) tests
    • Manual testing
  • UX of all users considered:
    • Speech
    • Braille
    • Low Vision
    • Different web browsers
    • Localization in other languages / culture than English
  • API is compatible with existing add-ons.
  • Security precautions taken.

@coderabbitai summary

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 Qchristensen requested a review from a team as a code owner July 25, 2025 01:05
Comment thread user_docs/en/userGuide.md Outdated
Comment thread user_docs/en/userGuide.md Outdated
Comment thread user_docs/en/userGuide.md Outdated
Comment thread user_docs/en/userGuide.md

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:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@SaschaCowley SaschaCowley merged commit a30937b into master Jul 25, 2025
20 checks passed
@SaschaCowley SaschaCowley deleted the QuickstartLinksBranch branch July 25, 2025 04:30
@SaschaCowley SaschaCowley added this to the 2025.3 milestone Aug 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants