Start a style guide for the User Guide#13916
Merged
Merged
Conversation
CyrilleB79
reviewed
Jul 18, 2022
feerrenrut
reviewed
Jul 20, 2022
See test results for failed build of commit a50d9472b2 |
feerrenrut
approved these changes
Jul 22, 2022
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:
There is no set of standards or guide when writing documentation for the "User Guide".
Description of user facing changes
The intended audience for this PR is NVDA contributors.
NVDA developers now have suggested formatting for key commands and feature flags.
Feature flag documentation suggests using definition lists.
The default CSS formatting for definition lists is not ideal, the term and definition are listed on separate lines. There is no text formatting, the only indication that a term is linked to a definition is an indentation in front of the term.
This is an example of default formatting:

Example of new formatting, where all text is smaller and italicised, terms are bold and definitions are on the same line as the term.


FireFox/Chrome:
Mobile:
Description of development approach
Created a style guide document
Testing strategy:
Tested rendering the user guide with #13131
Known issues with pull request:
Change log entries:
Code Review Checklist: