Thanks to visit codestin.com
Credit goes to github.com

Skip to content

feat: populate docs prose style guide as a landing page plus subpages - #26632

Merged
nickvigilante merged 7 commits into
mainfrom
vigilante/docs-434-populate-docsstylestyle-guidemd-prose-sections
Jun 25, 2026
Merged

feat: populate docs prose style guide as a landing page plus subpages#26632
nickvigilante merged 7 commits into
mainfrom
vigilante/docs-434-populate-docsstylestyle-guidemd-prose-sections

Conversation

@nickvigilante

@nickvigilante nickvigilante commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Replace the docs/.style/style-guide.md scaffold with the populated prose style guide,
structured as a README.md landing page plus one subpage per topic so GitHub auto-renders the landing when readers open the style-guide folder.

Layout

docs/.style/
  style-guide/
    README.md                          (landing: intro, section list, editing conventions, Vale enforcement)
    audience-and-scope.md              (one audience, one outcome, declared up front; canonical personas)
    voice-and-tone.md
    word-choice.md
    accessibility-and-inclusion.md     (new)
    capitalization-and-punctuation.md
    formatting.md                      (text formatting + block elements + screenshots sparingly)
    numbers-units-and-dates.md
    editor-setup.md                    (placeholder)

Every repo reference to the old path is rewired to the new path: AGENTS.md (and its CLAUDE.md / .cursorrules symlinks), .claude/docs/DOCS_STYLE_GUIDE.md, docs/about/contributing/documentation.md, docs/.style/README.md, docs/.style/styles/Coder/README.md, and a comment in .github/workflows/ci.yaml. The touched paragraph in each of those files is reformatted to one sentence per line per the touch-paragraph rule (refer to Conventions the guide dogfoods).

What each page covers

  • Audience and scope (new): every page targets one audience working toward one outcome; the install-vs-deploy Coder example (workspace user vs platform engineer); pick one audience per page (write two pages and cross-link rather than tagging sections); pick one outcome per page (Configure SSO with Okta is one outcome, Configure SSO is not); declare audience and scope up front (the H1 names the outcome; the first paragraph names the audience); canonical Coder personas inlined as four primary (Dave the Developer, Ada the Infrastructure Admin, Perry the Platform Engineer, Steven the Sponsor) and six secondary (Melissa the Machine Learner, Tommy the Tester, Caitlin the Citizen Developer, Felipe the FinOps, Sergio the Security Officer, Tara the Team Leader), each with a Coder surface: line covering the relevant CLI/workspace/template/RBAC surfaces.
  • Voice and tone: address the reader directly, avoid first-person singular, reserve first-person plural for Coder Technologies the company (with an explicit ban on we for the product itself and on combined you and the docs), active voice, present tense with a conditional/predictive will exception (If you do X, Y will happen), no sentence-ending prepositions with a clunky-exception note.
  • Word choice: Coder product and feature names with the Coder CLI always in backticks (coder) rule, brand names with a parallel Terraform CLI in backticks (terraform) rule, Dev Container terminology (proper-noun specification vs lowercase instance, parallel to Coder / workspace), phrasal verbs and their noun forms generalized as a table (set up/setup, log in/login, sign in/sign-in, log out/logout, back up/backup, roll out/rollout, start up/startup, shut down/shutdown, with the Quickstart exception), refer to / check out / visit over see, Learn more versus Next steps with an ableism rationale (steps as a physical-mobility metaphor), tutorial versus walkthrough with an ableism rationale, select over click, Don't assume simplicity or difficulty (covers both simple/easy and complex/non-trivial), Avoid weasel words (vague attributions in the Wikipedia sense like many believe, experts agree, studies show), plain language for product actions with an industry-term exception scope for the Linux kill command, the SIGKILL signal, and the disabled config flag state.
  • Accessibility and inclusion (new): WCAG 2.1 Level AA as the minimum target with AAA as a stretch goal; heading structure (one H1 per page, no skipped levels, substantive content between headings); inclusive pronouns; inclusive-language substitutions including a dedicated sanity check row with smoke testing / confidence testing / acceptance testing alternatives; descriptive link text; alt text and decorative-image conventions; plain English for international readers (no idioms; common Latin abbreviations e.g., i.e., etc., vs., and et al. allowed, less common ones not); page descriptions in docs/manifest.json (the docs site does not yet support YAML front matter); reading level; color contrast deferred to the docs site theme.
  • Capitalization and punctuation: sentence-case headings, no gerund-leading headings with documented exceptions (Pricing, Billing, Logging, String formatting, etc.), trailing heading punctuation in three tiers (periods and exclamation marks forbidden at error severity, question marks allowed sparingly at suggestion severity, characters inside backticks exempt for both), no em or en-dashes with a corrected example showing parenthetical em-dash use rather than series-joining, Oxford comma, US-style quotation, semicolons sparingly, rare exclamation marks, numeric ranges.
  • Formatting: text formatting (bold for UI with explicit greater-than separator rule for navigation paths, italics for emphasis, code font for identifiers presented as a bulleted list) and block elements (code blocks with language fences plus link to the Prism supported-languages reference, callouts with tightened scenarios, tabs with the actual `` syntax and a macOS/Linux/Windows example, lists with a five-item prose-list cap rule and an explicit terminal-punctuation rule (complete sentences end in periods, phrases completing a lead-in paragraph end in periods, single-word labels carry no terminal punctuation, no mixing styles in one list), tables with a narrow-table guideline that reconsiders the structure when many columns are needed, links including the rule that non-docs codebase links also use relative paths, images, screenshots sparingly with a maintenance-burden rationale and an adapted quote from Lorna Jane Mitchell's Short tech writing style guide for developers), with cross-references to the accessibility page for link text and alt text.
  • Numbers, units, and dates: digits everywhere preference, non-breaking space between number and unit with separate pre-render (Markdown source) and post-render (visible output) demonstrations plus a window-shrink tip for confirming the rule visually, Month Day, Year date format, 12-hour time with AM/PM, ordinals exception.
  • Editor setup: placeholder.

Conventions the guide dogfoods

  • One sentence per line. Source lines follow a one-sentence-per-line policy: each sentence sits on its own Markdown source line, sentences are not split across lines, and lines do not wrap to a fixed column width. The same convention applies corpus-wide through an incremental touch-paragraph rule: when a contributor edits any line inside a paragraph, the whole paragraph is reformatted to one sentence per line as part of the same edit. Bullet items, numbered list entries, and blockquote lines are each their own paragraph for the rule. Headings, fenced code blocks, and tables are out of scope. markdownlint's MD013 is already disabled, so the convention is editorial.
  • No navigational see. Replaced with refer to (formal default), check out (informal/tutorials), or visit (external URLs). See is reserved for the observational meaning.
  • HTML entities for em-dashes inside demos. The em-dash demo encodes / so the source stays ASCII while the rendered output still shows the character.
  • No semicolons in body prose. Body prose prefers two sentences over a semicolon. Semicolons survive only in heading and rule labels where they act as separators.
  • Common Latin abbreviations allowed in own prose. e.g., i.e., etc., vs., and et al. (citation contexts) are fine. Less common Latin abbreviations (a priori, q.v., viz., n.b., cf., ibid.) are not. The rule covers punctuation too: prefer parentheses around e.g. and i.e. clauses, one period when etc. ends a sentence, both periods when etc. ends a parenthetical that ends a sentence.
  • No idioms or industry-jargon idioms. deep dive, paved path, etc. are rewritten in plain language.

Rule conventions

Each rule pairs a rationale with Do / Don't blockquoted examples and a parenthetical noting the Vale rule that enforces (or will enforce) the policy. Documentation-only rules are explicitly labeled as such. Substitution rules use tables.

Out of scope

  • Wiring any new Vale rule. Per-rule PRs land separately per the rule-authoring doctrine in docs/.style/README.md.
  • Editor setup page population.
  • Redirecting docs/about/contributing/documentation.md to the populated guide (needs a coordinated coder.com PR after merge).
  • Trimming the Writing Style block in .claude/docs/DOCS_STYLE_GUIDE.md and removing the currently a scaffold framing in the agent docs.
  • A separate demo PR for the callout types rendered against an existing docs page.
  • Sweeping navigational see out of other docs files. The new rule only dogfoods on the style guide itself; a corpus-wide sweep is a separate ticket.

Validation

  • make fmt/markdown: clean.
  • make lint/markdown: 0 errors across 494 files.
  • ./scripts/check_emdash.sh: clean.
  • Pre-commit-light: passes (fmt + lint + emdash + shellcheck + typos + actionlint + migrations + helm).
  • Dogfood scan: no first-person singular in own prose, no idioms, only the five allowed Latin abbreviations in own prose, no walkthrough or Next steps outside rule definitions and examples, no navigational see, no click outside rule definitions and examples, no semicolons in body prose.
CI flake note: check-docs (linkspector)

The check-docs job can fail intermittently on pre-existing external links in docs/about/contributing/documentation.md (lines 29 and 30): Merriam-Webster occasionally returns HTTP 403 to GitHub Actions runners and Chicago Manual of Style can time out at 30s. Neither link is touched by this PR. docs/.style/ itself is in .github/.linkspector.yml excludedDirs, and linkspector annotations confirm zero broken links from the new pages.

Resolves DOCS-434.


Filed via Coder Agents on Nick's behalf.

@linear-code

linear-code Bot commented Jun 23, 2026

Copy link
Copy Markdown

DOCS-434

@nickvigilante
nickvigilante force-pushed the vigilante/docs-434-populate-docsstylestyle-guidemd-prose-sections branch from e6e265d to 4972a88 Compare June 24, 2026 14:07
@nickvigilante nickvigilante changed the title feat(docs/.style/style-guide.md): populate prose style guide sections feat(docs/.style): populate prose style guide as a landing page plus subpages Jun 24, 2026
@nickvigilante
nickvigilante force-pushed the vigilante/docs-434-populate-docsstylestyle-guidemd-prose-sections branch from 4972a88 to affbb55 Compare June 24, 2026 15:48
@github-actions

Copy link
Copy Markdown
Contributor

Docs preview

📖 View docs preview for docs/about/contributing/documentation.md

@nickvigilante
nickvigilante force-pushed the vigilante/docs-434-populate-docsstylestyle-guidemd-prose-sections branch from affbb55 to 363961c Compare June 24, 2026 15:52
@nickvigilante nickvigilante changed the title feat(docs/.style): populate prose style guide as a landing page plus subpages feat: populate docs prose style guide as a landing page plus subpages Jun 24, 2026
@nickvigilante

Copy link
Copy Markdown
Contributor Author

Heads up: check-docs keeps failing on the linkspector step. Both failures so far flag external links in docs/about/contributing/documentation.md that this PR does not touch:

  • Line 29: https://www.merriam-webster.com/ returns HTTP 403 from the GitHub runner IPs.
  • Line 30: https://www.chicagomanualofstyle.org/home.html times out at the 30s navigation limit.

The PR touches that file only at line 38 to update the style-guide path. The flaking links are in the third-party references table that has been there for a while.

The new docs/.style/style-guide/README.md carries the same links in its own third-party table, but docs/.style/ is excluded from linkspector by .github/.linkspector.yml (excludedDirs), so the new file does not contribute to the failure.

If the failure persists, two options:

  1. Add merriam-webster.com and chicagomanualofstyle.org to the ignorePatterns list in .github/.linkspector.yml. Out of scope for this PR.
  2. Replace the external links in documentation.md with redirects to the populated style guide. Also out of scope (the redirect work is its own follow-up).

Flagging per the flake-handling workflow (check runs on a changed path).

Filed via Coder Agents on Nick's behalf.

@nickvigilante
nickvigilante force-pushed the vigilante/docs-434-populate-docsstylestyle-guidemd-prose-sections branch 2 times, most recently from aba9cc5 to b07ed92 Compare June 24, 2026 20:42
@nickvigilante
nickvigilante marked this pull request as ready for review June 24, 2026 20:43
@nickvigilante
nickvigilante requested a review from bpmct June 24, 2026 20:44
@nickvigilante
nickvigilante force-pushed the vigilante/docs-434-populate-docsstylestyle-guidemd-prose-sections branch from b07ed92 to c01bb02 Compare June 24, 2026 20:52
Replace the scaffold with the populated prose style guide,
structured as a README.md landing page plus one subpage per topic so
GitHub auto-renders the landing when readers open the style-guide
folder:

- style-guide/README.md (landing): intro, section list, conventions
  for editing Coder docs (semantic line breaks with an
  incremental-adoption touch-paragraph rule, no navigational
  "see"), Vale enforcement summary, relationship to the public
  contributing page, third-party references including the Google
  developer documentation style guide.
- style-guide/audience-and-scope.md: every page targets one audience
  working toward one outcome; the install-vs-deploy Coder example;
  pick one audience per page; pick one outcome per page; declare
  audience and scope up front; canonical Coder personas (Dave, Ada,
  Perry, Steven as primary; Melissa, Tommy, Caitlin, Felipe, Sergio,
  Tara as secondary) with each persona's role, what they need from
  the docs, and the Coder surface they typically work with.
- style-guide/voice-and-tone.md: address the reader directly, avoid
  first-person singular, reserve first-person plural for Coder
  Technologies the company (with a contact-sales example, an
  explicit ban on "we" for the product itself, and a ban on
  combined "you and the docs"), active voice, present tense with a
  conditional/predictive "will" exception, no sentence-ending
  prepositions.
- style-guide/word-choice.md: Coder product and feature names (with
  the Coder CLI always in backticks rule), brand names (with a
  parallel rule for the Terraform CLI in backticks), Dev Container
  terminology (proper-noun specification vs lowercase instance),
  phrasal verbs and their noun forms generalized as a table (set
  up/setup, log in/login, sign in/sign-in, log out/logout, back
  up/backup, roll out/rollout, start up/startup, shut down/shutdown,
  with the Quickstart exception), refer to versus see, learn more
  versus next steps with an ableism rationale, tutorial versus
  walkthrough with an ableism rationale, select versus click, don't
  assume simplicity or difficulty (covers both "simple"/"easy" and
  "complex"/"non-trivial"), avoid weasel words (vague attributions
  in the Wikipedia sense), plain language for product actions with
  an industry-term exception scope for the Linux kill command, the
  SIGKILL signal, and the disabled config flag state.
- style-guide/accessibility-and-inclusion.md: WCAG 2.1 AA minimum and
  AAA stretch target; heading structure (one H1 per page, no skipped
  levels, content between headings); inclusive pronouns;
  inclusive-language substitutions including a dedicated row for
  sanity check alternatives; descriptive link text; alt text and
  decorative-image conventions; plain English for international
  readers (no idioms, no Latin abbreviations); page descriptions in
  docs/manifest.json; reading level with WCAG 2.1 AAA SC 3.1.5
  mapping; color contrast deferred to the docs site theme.
- style-guide/capitalization-and-punctuation.md: sentence-case
  headings, no gerund-leading headings with documented exceptions
  (Pricing, Billing, Logging, etc.), trailing heading punctuation in
  three tiers (periods and exclamation marks forbidden at error
  severity, question marks allowed sparingly at suggestion
  severity, characters inside backticks exempt for both), no em or
  en-dashes with corrected example showing parenthetical em-dash use
  rather than series-joining, Oxford comma, US-style quotation,
  semicolons sparingly, rare exclamation marks, numeric ranges.
- style-guide/formatting.md: text formatting (bold for UI with
  greater-than separator for navigation paths, italics for emphasis,
  code font for identifiers as a bulleted list) and block elements
  (code blocks with language fences and Prism reference, callouts
  with tightened scenarios, tabs with the div class="tabs" syntax
  and macOS/Linux/Windows example, lists with a five-item prose-list
  cap and explicit terminal-punctuation rule, tables with a
  narrow-table guideline that reconsiders the structure when many
  columns are needed, links including non-docs codebase relative
  paths, images, screenshots sparingly with a maintenance-burden
  rationale and the Lorna Jane example-vs-screenshot adaptation),
  with cross-references to accessibility-and-inclusion.md for link
  text and alt text.
- style-guide/numbers-units-and-dates.md: digits everywhere
  preference, non-breaking space between number and unit with
  pre-render and post-render demonstrations and a window-shrink tip,
  Month Day, Year date format, 12-hour time with AM/PM, ordinals
  exception.
- style-guide/editor-setup.md: placeholder.

Update repo references to the new path (AGENTS.md and its symlinks,
.claude/docs/DOCS_STYLE_GUIDE.md, docs/about/contributing/documentation.md,
docs/.style/README.md, docs/.style/styles/Coder/README.md, and a
comment in .github/workflows/ci.yaml). Reformat the touched
paragraphs in each of those files to semantic line breaks per the
new touch-paragraph rule.

The guide dogfoods its own rules. Source lines follow semantic line
breaks (sembr.org), and the same convention applies corpus-wide
through an incremental touch-paragraph rule: when a contributor
edits any line inside a paragraph, the whole paragraph is
reformatted in semantic line breaks as part of the same edit.
Navigational "see" is replaced with refer to, check out, or visit
throughout the guide. Em-dashes inside demo examples are HTML
entities so the source stays ASCII while still rendering the
character. Body prose prefers two sentences over a semicolon. Latin
abbreviations are replaced with plain English.
@nickvigilante
nickvigilante force-pushed the vigilante/docs-434-populate-docsstylestyle-guidemd-prose-sections branch from c01bb02 to 9021b60 Compare June 24, 2026 21:20
Comment thread docs/.style/style-guide/accessibility-and-inclusion.md
Comment thread docs/.style/style-guide/accessibility-and-inclusion.md Outdated
Comment thread docs/.style/style-guide/audience-and-scope.md Outdated
Comment thread docs/.style/style-guide/audience-and-scope.md
Comment thread docs/.style/style-guide/audience-and-scope.md
Comment thread docs/.style/style-guide/capitalization-and-punctuation.md Outdated
Comment thread docs/.style/style-guide/formatting.md
Comment thread docs/.style/style-guide/numbers-units-and-dates.md
Comment thread docs/.style/style-guide/word-choice.md Outdated
Comment thread docs/.style/style-guide/word-choice.md
- word-choice: simplify dev container terminology to match the spec's own usage. Reserve capitalized 'Dev Container' for the proper-noun shorthand 'Dev Container Spec'. Use lowercase 'dev container' for the category. Note that Coder's product 'Dev Containers' integration is named by the product feature rule.
- accessibility-and-inclusion: add a collapsible details block on the rationale for avoiding Latin abbreviations. Drop the implication that WCAG 2.1 bans them. Cite Google, Microsoft, 18F, and PLAIN style guidance instead.
- audience-and-scope: replace 'workspace user' with 'end user'. Add a hub pages and category landing pages section that allows broad titles when the page's job is to route. Rewrite 'Declare audience and scope up front' to drop the metadata line pattern and add a prerequisite callout subsection for privileged pages. Reorder primary personas with Perry first. Add Elliot the End User as a stopgap umbrella persona for non-developer end users. Replace he/she pronouns with they throughout.
…ules

Two follow-ups from the round-2 review feedback that bpmct and Nick
both wanted codified rather than left implicit:

- accessibility-and-inclusion: new 'Page title and sidebar title'
  section that defines the H1 and the manifest.json sidebar title as
  separate labels with different jobs. The H1 is grammatical and
  outcome-focused. The sidebar title is a navigation label that fits
  the sidebar and reads fast under breadcrumb context. The two must
  each stand alone but do not need to be identical. Worked example
  uses the Administration > Authentication > Google path.

- formatting: new 'Semantic line breaks' section that documents the
  sembr convention the rest of the style guide already follows.
  Records the convention so writers and reviewers don't have to
  reverse-engineer it from the existing prose.
nickvigilante added a commit that referenced this pull request Jun 25, 2026
Replace prose prerequisites and add scope-appropriate callouts on the
install index page so reviewers can see how the five GitHub callout
types (NOTE, TIP, IMPORTANT, WARNING, CAUTION) render in the production
Coder docs theme.

The page already had a TIP for coder/skills. This commit adds:

- NOTE distinguishing the mainline and stable release channels.
- WARNING about the curl-pipe-shell pattern in the Linux/macOS
  install script, with the security-conscious alternative.
- IMPORTANT for the Visual C++ Runtime prerequisite on Windows,
  upgraded from inline prose so readers do not skim past it.
- CAUTION about exposing the dashboard without authentication when
  binding the Coder server to a public IP or DNS name.

The demo answers the open question on review of PR #26632: whether
IMPORTANT and CAUTION render distinctly enough in the production theme
to justify keeping both, or whether the prose style guide should
consolidate. Each callout is also a genuine improvement to the install
page and stands on its own merits if the team decides to land it.
…ghlighter note

Add a Word choice rule that keeps internal-only references (issue-tracker
IDs, private repositories, internal-only links) out of published docs, so
every reader and contributor can open every linked resource. List it in the
README section table.

Correct the Formatting code-block guidance: the docs site highlights with
Speed-Highlight (content-based detection), not Prism. The fence label still
drives GitHub and editor highlighting and is required by markdownlint MD040.
Add `powershell` for Windows blocks, clarify `console` versus `sh`, and note
`tf` covers Terraform and HCL.

Part of DOCS-434.

Filed via Coder Agents on Nick's behalf.
@nickvigilante

Copy link
Copy Markdown
Contributor Author

Pushed a small follow-on commit (64bb23b) that came out of the Get Started docs experiment:

  1. New Word choice rule: "Keep internal-only references out of published docs." Keeps issue-tracker IDs (for example ABC-123), private repositories, and internal-only links out of published pages, so every reader and contributor (community or employee) can open everything the docs link to. Internal trackers still belong in PR descriptions, commit messages, and review comments. Added to the README section table; planned Vale rule Coder.InternalReferences.
  2. Corrected the code-block highlighter note in formatting.md. It said the docs site uses Prism; the renderer actually detects the language from the code content and ignores the fence label. Reworded so the fence-label requirement is justified by GitHub/editor rendering plus markdownlint MD040, added powershell for Windows blocks, clarified console vs sh, and noted tf covers Terraform and HCL.

make fmt/markdown, make lint/markdown, make lint/prose, and check_emdash.sh are all clean. Happy to break these out into their own PR if you'd rather keep this one tightly scoped.

Filed via Coder Agents on Nick's behalf.

…, and preposition rules

Address review feedback from the Quickstart Part 2 experiment (#26712):

- formatting.md: a command with no output uses `sh`, not `console`;
  `console` requires shown output with `$` prefixes; `sh` is the canonical
  shell label over `bash`/`shell`; document the generated CLI-reference
  exception. Add a "Learn more / See also" list example (link fragments,
  no terminal periods, no leading "Or", clean lead-in stem).
- capitalization-and-punctuation.md: new Commas section covering the
  introductory-element comma, no comma in a short compound predicate, the
  Oxford comma, and a note that semantic line breaks never change
  punctuation.
- word-choice.md: prefer "learn" or "find out" over "see" for comprehension
  outcomes.
- audience-and-scope.md: give the audience only what it needs; do not add
  wrong-role caveats when the audience already has the access.
- voice-and-tone.md: reframe trailing prepositions as a judgment call with
  examples in both directions.

Refs: DOCS-434
Filed via Coder Agents on Nick's behalf.
Comment thread docs/.style/style-guide/formatting.md Outdated
Comment thread docs/.style/style-guide/numbers-units-and-dates.md
Comment thread docs/.style/style-guide/numbers-units-and-dates.md

@bpmct bpmct left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM pending a few things in this review and discussed async

…n abbreviation rule

Two policy revisions to the in-progress prose style guide.

Line breaks: replaces the semantic line breaks (sembr) rule with a hard one-sentence-per-line rule, on the rationale that one sentence per line is easier to produce reliably for humans and LLMs alike, avoids the short-line-in-quick-succession clutter that sembr generates, and still wins on diff clarity. A small edit changes one line, so reviewers see the changed sentence in isolation.

- formatting.md: the 'Semantic line breaks' rule is replaced with 'One sentence per line'. The new rule section is itself written in the new format so it dogfoods the rule. The two 'Don't' examples now flag clause-level breaks (the old sembr convention) and fixed column wrapping as the two failure modes.

- README.md: the 'Conventions for editing Coder docs' section now points at one sentence per line. The 'Incremental adoption' subsection retains the touch-paragraph rule, rephrased as 'reformat to one sentence per line', and acknowledges that earlier paragraphs in this style guide still carry sembr from prior commits in this PR.

- capitalization-and-punctuation.md: the 'Semantic line breaks do not change punctuation' subsection is deleted. The footgun it guarded against (using a line break in place of a comma) cannot happen when every sentence sits on one line, so the section has no analog under the new rule.

Latin abbreviations: backs out the ban on all Latin abbreviations and allows five specific ones: 'e.g.', 'i.e.', 'etc.', 'vs.', and 'et al.' (citation contexts). These five are near-universal in industry technical writing.

- accessibility-and-inclusion.md: 'Avoid Latin and other foreign-language abbreviations' becomes 'Latin abbreviations' (permissive heading for a permissive rule). The new section codifies four practical rules: prefer parentheses around 'e.g.' and 'i.e.' clauses to avoid comma cascades; one period when 'etc.' ends a sentence, both periods when 'etc.' ends a parenthetical that ends a sentence; the author-date citation form for 'et al.'; less common Latin ('a priori', 'q.v.', 'viz.', 'n.b.', 'cf.', 'ibid.') stays banned. The 'Why' details block now justifies the carve-out rather than the ban, citing the same Google, Microsoft, 18F, and PLAIN sources reframed for the permissive policy.

- The planned 'Coder.LatinAbbreviations' Vale rule is dropped from the documentation. The Idioms section above gets its own '*Documentation-only. Planned Vale rule Coder.Idioms.*' footer so the planned-rule reference is preserved when the joint footer goes away.

The rest of the style guide still carries sembr from prior commits on this PR. The touch-paragraph rule in 'README.md' handles incremental conversion as paragraphs are edited.
… line

Apply the one-sentence-per-line rule from the README's Incremental adoption section across the prose changed in this PR.

Full sweep across the nine style-guide subpages: README.md, accessibility-and-inclusion.md, audience-and-scope.md, capitalization-and-punctuation.md, editor-setup.md, formatting.md, numbers-units-and-dates.md, voice-and-tone.md, word-choice.md.

Touched-paragraphs-only sweep across the five path-rewire files: docs/.style/README.md, docs/.style/styles/Coder/README.md, AGENTS.md, .claude/docs/DOCS_STYLE_GUIDE.md, docs/about/contributing/documentation.md.

Lints clean: make lint/markdown and make lint/prose.
@nickvigilante
nickvigilante enabled auto-merge (squash) June 25, 2026 21:07
@nickvigilante
nickvigilante merged commit b95f253 into main Jun 25, 2026
34 of 37 checks passed
@nickvigilante
nickvigilante deleted the vigilante/docs-434-populate-docsstylestyle-guidemd-prose-sections branch June 25, 2026 21:11
@github-actions github-actions Bot locked and limited conversation to collaborators Jun 25, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants