Skip to content

Commit

Permalink
Fix up order for feature descriptions in the user guide standards (#1…
Browse files Browse the repository at this point in the history
…6667)

Summary of the issue:
As discussed in #16490 and #15902 (comment) that feature descriptions should come before settings tables for features in the user guide.
This is because a basic description is more common than detailed tables in reference manuals

Description of user facing changes
Fixes up order for feature descriptions in the user guide standards
  • Loading branch information
seanbudd committed Jun 7, 2024
1 parent 3f004f5 commit 1a1cb5f
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@

# For changes to the userGuide auto request review from userDocs team
/user_docs/en/userGuide.md @nvaccess/userDocs
/projectDocs/dev/userGuideStandards.md @nvaccess/userDocs

# For various project documentation, require appropriate teams
/projectDocs/community/ @nvaccess/userDocs
Expand Down
10 changes: 5 additions & 5 deletions projectDocs/dev/userGuideStandards.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,20 +21,20 @@ Once the anchor is set it cannot be updated, while settings may move categories.
```md
==== The name of a feature ====[FeatureDescriptionAnchor]

Brief summary of the feature.
This setting allows the feature of using functionality in a certain situation to be controlled in some way.
If necessary, a description of a common use case that is supported by each option.

| . {.hideHeaderRow} |.|
|---|---|
|Options |Default (Enabled), Disabled, Enabled|
|Default |Enabled|
|Options |Default (Enabled), Disabled, Enabled |
|Default |Enabled |
|Toggle command |`NVDA+shift+e` |

|Option |Behaviour |
|---|---|
|Enabled |behaviour of enabled |
|Disabled |behaviour of disabled |

This setting allows the feature of using functionality in a certain situation to be controlled in some way.
If necessary, a description of a common use case that is supported by each option.
```

## Generation of Key Commands
Expand Down

0 comments on commit 1a1cb5f

Please sign in to comment.