Skip to content

Commit

Permalink
Improved copy
Browse files Browse the repository at this point in the history
  • Loading branch information
nikola-nulogy authored Jan 26, 2024
1 parent a3a9d63 commit eeef517
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions src/pages/grammar-and-mechanics/capitalization.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ import CapitalizationCheatSheet from "./docs/Capitalization-cheat-sheet.pdf";

# Capitalization

In general, we always use sentence case. Sentence case is when the first letter of the first word of the phrase is capitalized and each word after is lowercase.
In general, we always use sentence case. Sentence case is when the first letter of the first word of the phrase is capitalized, and each word after is lowercase.

For a comprehensive list of rules and examples please refer to the <Link href={CapitalizationCheatSheet}>capitalization cheatsheet</Link>.
For a comprehensive list of rules and examples, please refer to the <Link href={CapitalizationCheatSheet}>capitalization cheat sheet</Link>.

On a high level these are are some general rules:
On a high level, these are some general rules:

## Headings

Expand All @@ -18,7 +18,7 @@ Headings and subheadings use sentence case.

## Product names

Use title case for the names of our products
Use title case for the names of our products.

<NoExample>
The ecosystem solution allows brands insights into the production process.
Expand All @@ -29,7 +29,7 @@ Use title case for the names of our products

## Team names

Use title case for the names of our or customers' teams
Use title case for the names of our or customers' teams.

<NoExample>
Someone from professional services will contact you.
Expand All @@ -43,17 +43,17 @@ Use title case for the names of our or customers' teams

## Tools

Tools should be lowercase, unless they are beginning a sentence or header.
Tools should be lowercase unless they are beginning a sentence or header.

<NoExample>Find pallets thorugh Item Locator</NoExample>
<YesExample>Find pallets through item locator.</YesExample>

## Nulogy objects

Only capitalize an unique instances of Nulogy objects that refer to a specific example.
Only capitalize unique instances of Nulogy objects that refer to a specific example.

<NoExample>The pick list associated with ship order 12345 ...</NoExample>
<YesExample mb="x4">The pick list associated with Ship Order 12345 ...</YesExample>
<NoExample>The pick list associated with ship order 12345...</NoExample>
<YesExample mb="x4">The pick list associated with Ship Order 12345...</YesExample>

General references to a Nulogy object should be lowercase.

Expand All @@ -62,11 +62,11 @@ General references to a Nulogy object should be lowercase.

## Reference to UI elements

Use the same capitalization as in UI when refering to UI elemnts in your documentation, ip-app content, or customer communications.
Use the same capitalization as in the UI when referring to UI elements in your documentation, in-app content, or customer communications.

Add visual emphasis (bold, italic, or _) for enhanced understanding.
Add visual emphasis (bold, italic, or '_') for enhanced understanding.

<NoExample>Click Save Now Button</NoExample>
<YesExample mb="x4">Click <strong>Save now</strong> button</YesExample>

For a more in exhaustive breakdown of rules please refer to the <Link href={CapitalizationCheatSheet}>capitalization cheatsheet</Link>.
For a more exhaustive breakdown of rules, please refer to the <Link href={CapitalizationCheatSheet}>capitalization cheat sheet</Link>.

0 comments on commit eeef517

Please sign in to comment.