Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions docs-linter/lint.sh
Original file line number Diff line number Diff line change
Expand Up @@ -109,3 +109,5 @@ fi

# --- REMOVE TEMP FILES ---
rm "$LIST_FILE" "$VALE_LOG" "$MD_LOG" "$VALE_CLEAN" "$MD_CLEAN"

[ "$TOTAL" -eq 0 ] || exit 1
3 changes: 3 additions & 0 deletions nf-style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,9 @@ The exact top-level buckets we use for the ToC can vary depending on the product
historically associated with creating a record. Also, this aligns with most modern tech doc style guides.
- One word (hyphenated) for adjective ("the sign-in page") and two words for verb ("sign in to your account")
- For words with an acronym, write it out on first mention with the acronym in parentheses, then use only the acronym.
- Write "zero trust" with no hyphen, even as a compound adjective ("zero trust network access"). This is a NetFoundry
branding preference that overrides the usual compound-adjective hyphenation rule. Don't change file paths, slugs, or
code tokens that already contain the hyphenated form.

## Punctuation

Expand Down
Loading