Skip to content

docs: enforce american spelling and fix british variants#250

Merged
dangrondahl merged 5 commits into
mainfrom
fix_spelling
Jun 3, 2026
Merged

docs: enforce american spelling and fix british variants#250
dangrondahl merged 5 commits into
mainfrom
fix_spelling

Conversation

@dangrondahl
Copy link
Copy Markdown
Contributor

@dangrondahl dangrondahl commented Jun 3, 2026

Summary

  • Replace british spellings (organisation, behaviour, colour, standardised) with american equivalents across the published docs.
  • Add a Vale substitution rule at styles/Kosli/AmericanSpelling.yml that flags the british variants currently appearing in the docs, wired into .vale.ini for *.md files.
  • Note the convention in CLAUDE.md under Writing style, pointing to the Vale rule.

Notes

  • Kept the rule as an explicit word list rather than regex for readability; can compress to regex (organis(e|ed|ing) etc.) later if the list grows.
  • Scope intentionally limited to british variants that actually appear in the docs today, not a comprehensive british→american dictionary.
  • MDX files are not yet covered by local vale . runs (requires mdx2vast). 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 .md files.
  • Confirm mint dev still renders the edited tutorial and changelog pages without surprises.

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.
@dangrondahl dangrondahl requested a review from a team as a code owner June 3, 2026 07:10
@claude
Copy link
Copy Markdown
Contributor

claude Bot commented Jun 3, 2026

Claude finished @dangrondahl's task in 1m 33s —— View job


Review of PR #250 — American spelling enforcement

  • Read CLAUDE.md and doc-review skill
  • Gather full diff and read changed files
  • Check for regressions (test commits reverted?)
  • Review Vale config and spelling rule
  • Review content changes across all files
  • Post findings

Findings

Overall: 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 — resolved

The previous review flagged commits 3435664 and c188713 which introduced intentional British spellings as test probes. Commit 22efd58 reverts both cleanly — neither understand_kosli/glossary.md nor tutorials/organizing_with_spaces.mdx carry any residual test artifacts in the final diff. The .vale.ini was also updated to [*.{md,mdx}] (commit 0b2c3c4), addressing the earlier suggestion about MDX coverage.

Remaining British spelling in generated content

client_reference/kosli_get_snapshot.md:6277 contains "Reorganise" inside a quoted git commit message embedded in API response data. This is generated reference content (see scripts/ live docs), not authored prose — no action needed, and the Vale rule's ignorecase: true + file glob won't flag it since it's inside a code block.

Suggestion — squash before merge

The 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 main history clean. The final state is correct regardless.

Vale rule (styles/Kosli/AmericanSpelling.yml)

  • Well-structured substitution rule, ignorecase: true is appropriate.
  • Explicit word list is the right call at this size; regex can come later if the list grows significantly.
  • Covers the exact variants found in the docs today — intentionally scoped, as noted in the PR description.

Content changes — all correct

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.

@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented Jun 3, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
kosli 🟢 Ready View Preview Jun 3, 2026, 7:13 AM

Comment thread .vale.ini Outdated
Comment thread understand_kosli/glossary.md Outdated
Comment thread .vale.ini Outdated
Comment thread understand_kosli/glossary.md Outdated
Comment thread tutorials/organizing_with_spaces.mdx Outdated
Comment thread .vale.ini Outdated
Copy link
Copy Markdown
Contributor

@pbeckham pbeckham left a comment

Choose a reason for hiding this comment

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

Approved — I have analyzed the code great work standardizing the docs

@dangrondahl dangrondahl merged commit da5ce83 into main Jun 3, 2026
8 checks passed
@dangrondahl dangrondahl deleted the fix_spelling branch June 3, 2026 08:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants