docs: enforce american spelling and fix british variants#250
Conversation
Replace british spellings (organisation, behaviour, colour, standardised) with american equivalents across published docs. Add a Vale substitution rule at styles/Kosli/AmericanSpelling.yml covering the words that currently appear in the docs, plus a note in CLAUDE.md pointing to it.
|
Claude finished @dangrondahl's task in 1m 33s —— View job Review of PR #250 — American spelling enforcement
FindingsOverall: Clean, well-scoped PR. The spelling fixes are correct, the Vale rule is sensible, and the earlier review issues (test typos, mdx coverage) have been addressed. Test typo regressions — resolvedThe previous review flagged commits Remaining British spelling in generated content
Suggestion — squash before mergeThe branch has 5 commits, 3 of which are test scaffolding (introduce typo → extend mdx → revert typo). Consider squashing to 1–2 commits before merge to keep Vale rule (
|
| File | Change |
|---|---|
README.md |
colour → color |
changelog/index.mdx |
organisation → organization (×2), behaviour → behavior |
tutorials/cli_and_http_proxy.md |
organisation → organization |
tutorials/custom-attestation-ctrf.md |
standardised → standardized, organisation → organization |
tutorials/evaluate_trails_with_opa.mdx |
behaviour → behavior (×2) |
tutorials/following_a_git_commit_to_runtime_environments.md |
organisation → organization |
tutorials/organizing_with_spaces.mdx |
organisation → organization |
tutorials/report_cloud_run_envs.md |
behaviour → behavior |
tutorials/tracing_a_production_incident_back_to_git_commits.md |
organisation → organization (×2) |
No unintended content changes, no broken links introduced, no frontmatter modifications.
CLAUDE.md
New line under Writing style correctly documents the convention and points to the Vale rule file.
Summary
| Category | Count |
|---|---|
| Critical | 0 |
| Improvement | 0 |
| Suggestion | 1 (squash commits) |
This PR is ready to merge once the commit history is optionally tidied up. All earlier review feedback has been addressed.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
pbeckham
left a comment
There was a problem hiding this comment.
Approved — I have analyzed the code great work standardizing the docs
Summary
substitutionrule atstyles/Kosli/AmericanSpelling.ymlthat flags the british variants currently appearing in the docs, wired into.vale.inifor*.mdfiles.CLAUDE.mdunder Writing style, pointing to the Vale rule.Notes
organis(e|ed|ing)etc.) later if the list grows.vale .runs (requiresmdx2vast). Mintlify's Vale add-on can pick them up server-side if enabled.Test plan
vale --glob='!{.claudemd-eval,docs}/**' .reports 0 errors across published.mdfiles.mint devstill renders the edited tutorial and changelog pages without surprises.