Skip to main content

Documentation Index

Fetch the complete documentation index at: https://na-36-merge-docs-v2-dev-draft-into-docs-v2-clean-20260525.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Copy and Brand Pipeline

Gate: P3 (advisory — does not block merge) Trigger: PR touching v2/**/*.mdx or docs-guide/**/*.mdx Workflow: validator-brand-check-copy-standards.yml

What happens when copy changes

Auto-repair (manual dispatch)


Validators (P3 — advisory)

ScriptWhat it checksConfig
lint-copy.jsBanned words (effectively, essentially, basically, etc.), banned phrases, banned constructionsoperations/scripts/config/copy-standards.json
lint-patterns.jsCopy pattern violations (tone, structure)Pattern definitions in script
check-grammar-en-gb.jsUK English spelling (-ise not -ize, -our not -or, -re not -er)Custom EN-GB dictionary
check-proper-nouns.jsBrand names capitalised correctly (Livepeer, Arbitrum, Ethereum)operations/scripts/config/proper-nouns.json

Remediators

ScriptWhat it fixesMode
style-and-language-homogenizer-en-gb.jsAmerican → British English. Smart preservation of code blocks, URLs, proper nouns. ~80-90% auto-fixableManual dispatch
repair-spelling.jsIndividual spelling correctionsManual
wcag-repair-common.jsAccessibility text improvementsManual
repair-ownerless-language.jsLanguage style in ownerless governance docsManual

Standards

StandardLocation
Voice rules (7 audiences)docs-guide/standards/voice-and-copy.mdx
Banned words and phrasesdocs-guide/standards/voice-and-copy.mdx
UK English correction tabledocs-guide/standards/voice-and-copy.mdx
Domain terminologydocs-guide/standards/voice-and-copy.mdx
Naming conventionsdocs-guide/standards/naming-conventions.mdx

Gaps

  • Advisory only (P3): Brand checks do not block merge. Violations can ship to production. Transition to P2 (hard gate) not yet scheduled
  • No auto-repair on PR failure: Remediator exists but requires manual dispatch. No workflow auto-creates a fix PR when brand checks fail
  • No voice validation: Validators check spelling and banned words but not voice register (gateway vs delegator tone). Voice compliance is manual review only
Last modified on May 26, 2026