Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2025-08-08 06:04:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update style-guide.md

Browse Source
This commit is contained in:
stephffuller 2020-08-12 17:51:27 -04:00 committed by GitHub
parent 2e21faed98
commit 55f242355d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
.github/style-guide.md vendored
View File

@ -47,12 +47,12 @@ The following sections provide general guidelines on topics specific to Redocly
### General ### General
* Use active voice. Avoid passive voice. * Use active voice. Avoid passive voice.
- Passive: The heatmap visualization is displayed. - Passive: The page is displayed.
- Active: Redocly displays the heatmap visualization. - Active: Redocly displays the page.
* Write in the imperative second person. Examples: You can write an API. Click the panel. Close the window. * Write in the imperative second person. Examples: You can write an API. Click the panel. Close the window.
* Write in present tense. * Write in present tense.
- Not: The rule will check content. - Not: The rule will check content.
- Use: The checks content. Redocly checks the content. - Use: The rule checks content. Redocly checks the content.
* Do not use an ampersand (&) as an abbreviation for "and." * Do not use an ampersand (&) as an abbreviation for "and."
- **Exceptions:** If an ampersand is used in the Redocly UI, then match the UI. - **Exceptions:** If an ampersand is used in the Redocly UI, then match the UI.
* Avoid using internal slang and jargon in technical documentation. * Avoid using internal slang and jargon in technical documentation.