Skip to content

Update style-guide.md #510

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.

Sign up for GitHub

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Update style-guide.md #510

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
78e5332
Update style-guide.md
apgordon312 May 4, 2025
c35be65
Merge branch 'main' into patch-13
mjang May 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion templates/style-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,11 @@ When writing documentation for our project, align with the default guide's voice

- Using NGINX Plus Docker images with NGINX Instance Manager

- Don't use articles ("the", "a") in front of product names. For example, use
- Don't use articles ("the", "a") in front of product names. For example, use:
- NGINX Agent (not "the NGINX Agent").
- EXCEPTION: Use an article ("the", "a") if the product name is qualifying another noun. For example, use:
- Edit the NGINX Agent configuration file (not "Edit NGINX Agent configuration file") ← In this case, "NGINX Agent" is a descriptor for the term "configuration file".
- Expose NGINX Agent's REST API ← In this case, NGINX Agent is a standalone noun phrase, and it "possesses" the REST API.
- Always use the full brand name in the meta description. The meta description does not count as first mention of the product in the document.


Expand Down
Loading