Summary
In template/docs/documentation-style-guide.md, the Checkboxes rule (lines 632–633) uses American English spelling:
- **Checkboxes:** Precede task and sub-task items with a GitHub Flavored
Markdown (GFM) checkbox (`[ ]`) to track completion status.
The house style for docs/**/*.md files is en-GB-oxendict. Line 63 of the same file already spells this correctly as GitHub-flavoured. The Checkboxes rule must be updated to match.
Required change
Update lines 632–633 so that GitHub Flavored Markdown (GFM) reads GitHub-flavoured Markdown (GFM), preserving the GFM abbreviation and the remainder of the sentence unchanged.
Validation
- Run
make markdownlint to confirm 0 errors after the change.
- Verify
make check-fmt still passes.
Context
Raised from leynos/ortho-config#336 by @leynos.
Summary
In
template/docs/documentation-style-guide.md, the Checkboxes rule (lines 632–633) uses American English spelling:The house style for
docs/**/*.mdfiles is en-GB-oxendict. Line 63 of the same file already spells this correctly asGitHub-flavoured. The Checkboxes rule must be updated to match.Required change
Update lines 632–633 so that
GitHub Flavored Markdown (GFM)readsGitHub-flavoured Markdown (GFM), preserving the GFM abbreviation and the remainder of the sentence unchanged.Validation
make markdownlintto confirm 0 errors after the change.make check-fmtstill passes.Context
Raised from leynos/ortho-config#336 by @leynos.