Skip to content

Commit

Permalink
style(style guide): Clarify nav org, move punctuation (#17507)
Browse files Browse the repository at this point in the history
* style(style guide): Clarify nav org, move punctuation

* chore(style guide): Tweak pricing-related nav
  • Loading branch information
austin-schaefer authored May 31, 2024
1 parent 2689565 commit f909a42
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 16 deletions.
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Punctuation
redirects:
- /docs/style-guide/ui-writing/punctuation
---

In writing, punctuation marks are used to imitate speech and play an important role in communicating meaning in language. Misplaced exclamation marks, for instance, can dramatically change the tone or intent in a message.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: UI writing style
title: UI voice
---

When writing for the UI, we follow many of the same guidelines as the rest of the company. We've called out some specific elements in this section to address frequently asked questions or slight differences from the broader New Relic style guidelines.
Expand Down
30 changes: 15 additions & 15 deletions src/nav/style-guide.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ pages:
path: /docs/style-guide/capitalization/capitalization
- title: 'Product and capabilities: capitalization, trademarks, and usage'
path: /docs/style-guide/capitalization/product-capability-feature-usage
- title: Components and formatting
- title: Punctuation
path: /docs/style-guide/punctuation
- title: 'Docs: Components and formatting'
pages:
- title: Introduction to components
path: /docs/style-guide/structure/intro-to-components
Expand Down Expand Up @@ -57,7 +59,7 @@ pages:
path: /docs/style-guide/structure/titles
- title: UI paths
path: /docs/style-guide/structure/ui-paths
- title: 'Images, videos, and captions'
- title: 'Docs: Images, videos, and captions'
pages:
- title: Screenshots and images
path: /docs/style-guide/images/screenshots-images
Expand All @@ -69,15 +71,7 @@ pages:
path: /docs/style-guide/images/create-videos
- title: Embed videos
path: /docs/style-guide/images/embed-videos
- title: Word choice
pages:
- title: NerdGraph guidelines
path: /docs/style-guide/word-choice/nerdgraph-doc-guidelines
- title: Pricing and billing language guidelines
path: /docs/style-guide/word-choice/pricing-language-guidelines
- title: Users and roles language guidelines
path: /docs/style-guide/word-choice/user-related-language-guidelines
- title: Writing docs
- title: 'Docs: Writing docs'
pages:
- title: Five questions
path: /docs/style-guide/writing-strategies/five-questions-help-write-docs
Expand Down Expand Up @@ -153,6 +147,8 @@ pages:
path: /docs/style-guide/writing-docs/article-templates/branch-install-doc-reference
- title: Data dictionary style guidelines
path: /docs/style-guide/writing-docs/article-templates/data-dictionary-style-guidelines
- title: NerdGraph guidelines
path: /docs/style-guide/word-choice/nerdgraph-doc-guidelines
- title: Observability maturity template
path: /docs/style-guide/writing-docs/article-templates/om-implementation-guide
- title: Prometheus integration template
Expand All @@ -163,9 +159,15 @@ pages:
path: /docs/style-guide/writing-docs/article-templates/whats-new-template
- title: What's new tech writer tasks
path: /docs/style-guide/writing-docs/article-templates/whats-new-tech-writer-tasks
- title: UI writing style
- title: 'Pricing and accounts language'
pages:
- title: Pricing and billing language guidelines
path: /docs/style-guide/word-choice/pricing-language-guidelines
- title: Users and roles language guidelines
path: /docs/style-guide/word-choice/user-related-language-guidelines
- title: 'UI: Writing style'
pages:
- title: UI writing style
- title: UI voice
path: /docs/style-guide/ui-writing/ui-writing-style
- title: Abbreviations and acronyms
path: /docs/style-guide/ui-writing/abbreviations-and-acronyms
Expand Down Expand Up @@ -195,8 +197,6 @@ pages:
path: /docs/style-guide/ui-writing/places-and-names
- title: Plurals
path: /docs/style-guide/ui-writing/plurals
- title: Punctuation
path: /docs/style-guide/ui-writing/punctuation
- title: Ranges and spans
path: /docs/style-guide/ui-writing/ranges-and-spans
- title: Tooltips
Expand Down

0 comments on commit f909a42

Please sign in to comment.