Skip to content
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

Single anchor used two times in the user guide #16941

Closed
pvagner opened this issue Aug 1, 2024 · 2 comments · Fixed by #16959
Closed

Single anchor used two times in the user guide #16941

pvagner opened this issue Aug 1, 2024 · 2 comments · Fixed by #16959
Labels
component/documentation good first issue github features these at https://github.com/nvaccess/nvda/contribute p3 https://github.com/nvaccess/nvda/blob/master/projectDocs/issues/triage.md#priority triaged Has been triaged, issue is waiting for implementation.
Milestone

Comments

@pvagner
Copy link

pvagner commented Aug 1, 2024

Steps to reproduce:

  • Open this link:
    #### Recommended System Requirements {#MinimumSystemRequirements}
    * Operating Systems: 64-bit editions of Windows 10, Windows 11, and Window Server 2022
    * both AMD64 and ARM64 variants of Windows are supported.
    * at least 150 MB of storage space.
    * at least 4 GB of RAM.
    #### Minimum System Requirements {#MinimumSystemRequirements}
  • Look through line 42 and line 48

Actual behavior:

Same anchor is defined twice. Thus it's not possible to link to individual headings Recommended system requirements or Minimum system requirements

Expected behavior:

I have noticed this while translating user guide into slovak.
I think the anchor for Recommended system requirements should be changed into #RecommendedSystemRequirements`

NVDA logs, crash dumps and other attachments:

System configuration

NVDA installed/portable/running from source:

Not applicable. I am reading user guide in a web browser.

NVDA version:

Current development version

Windows version:

Name and version of other software in use when reproducing the issue:

Other information about your system:

Other questions

Does the issue still occur after restarting your computer?

Have you tried any other versions of NVDA? If so, please report their behaviors.

If NVDA add-ons are disabled, is your problem still occurring?

Does the issue still occur after you run the COM Registration Fixing Tool in NVDA's tools menu?

@seanbudd seanbudd added component/documentation p3 https://github.com/nvaccess/nvda/blob/master/projectDocs/issues/triage.md#priority good first issue github features these at https://github.com/nvaccess/nvda/contribute triaged Has been triaged, issue is waiting for implementation. labels Aug 1, 2024
@seanbudd seanbudd added this to the 2024.4 milestone Aug 1, 2024
@josephsl
Copy link
Collaborator

josephsl commented Aug 2, 2024

CC @Qchristensen, while at it, I propose rewriting these sections to state the absolute minimum system requirements (for all users) before stating recommended system requirements. Another option is to present the system requirements as a table, with separate columns for minimum and recommended requirements. That way we can only deal with one anchor.

Thanks.

@Qchristensen
Copy link
Member

Thanks @pvagner for raising this - and you are right @josephsl - it makes sense to have the minimum requirements above the recommended requirements. I've created PR #16959 to address both.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component/documentation good first issue github features these at https://github.com/nvaccess/nvda/contribute p3 https://github.com/nvaccess/nvda/blob/master/projectDocs/issues/triage.md#priority triaged Has been triaged, issue is waiting for implementation.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants