[CHORE] Fix outstanding textlint terminology errors and expand markdownlint ignores#296
Conversation
Co-authored-by: lowlydba <16843041+lowlydba@users.noreply.github.com>
Co-authored-by: lowlydba <16843041+lowlydba@users.noreply.github.com>
🚀 Overture Maps docs branch preview deployed!You can review your changes at https://staging.overturemaps.org/docs/pr/296/index.html ♻️ Last refreshed: 2026-03-13T15:46:10Z |
Signed-off-by: John McCall <john@overturemaps.org>
Signed-off-by: John McCall <john@overturemaps.org>
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
There was a problem hiding this comment.
Pull request overview
Addresses recent lint failures in the schema reference documentation by aligning terminology with textlint expectations and adjusting markdownlint configuration to better handle generated/reference content.
Changes:
- Fixes textlint terminology violations across multiple schema reference markdown files (e.g., “Key/value” → “Key-value”, “Id” → “ID”, “snake case” → “snake_case”).
- Adds a
.markdownlintignoreentry to exclude generated schema reference docs from markdownlint. - Disables additional markdownlint rules in
.markdownlint.json(MD031, MD032, MD034, MD060).
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/schema/reference/system/snake_case_string.md | Updates terminology to snake_case to satisfy textlint. |
| docs/schema/reference/system/ref/id.md | Adjusts heading terminology from “Id” to “ID”. |
| docs/schema/reference/places/place.md | Rewords websites field description to satisfy textlint terminology. |
| docs/schema/reference/base/water.md | Updates source_tags description from “Key/value” to “Key-value”. |
| docs/schema/reference/base/types/source_tags.md | Updates type description terminology to “Key-value”. |
| docs/schema/reference/base/land_use.md | Updates source_tags description from “Key/value” to “Key-value”. |
| docs/schema/reference/base/land.md | Updates “TODO” to “Todo” in prose to satisfy textlint. |
| docs/schema/reference/base/infrastructure.md | Updates source_tags description from “Key/value” to “Key-value”. |
| docs/schema/index.md | Updates “key/value” to “key-value” and removes extraneous blank line/whitespace. |
| .markdownlintignore | Ignores generated schema reference docs path for markdownlint. |
| .markdownlint.json | Disables additional markdownlint rules (MD031, MD032, MD034, MD060). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
Signed-off-by: John McCall <john@overturemaps.org>
Signed-off-by: John McCall <john@overturemaps.org>
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
Super-linter summary
Super-linter detected linting errors For more information, see the GitHub Actions workflow run Powered by Super-linter NATURAL_LANGUAGE |
Update .github/linters/.textlintrc.json to add a comments filter and simplify the terminology rule by excluding "TODO". Also update the lint workflow to set NATURAL_LANGUAGE_CONFIG_FILE to that config so the natural-language linter uses the repository config. Signed-off-by: John McCall <john@overturemaps.org>
Signed-off-by: John McCall <john@overturemaps.org>
Super-linter summary
Super-linter detected linting errors For more information, see the GitHub Actions workflow run Powered by Super-linter NATURAL_LANGUAGE |
Signed-off-by: John McCall <john@overturemaps.org>
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
Pull Request
Fixes 11 textlint terminology errors across schema reference docs and expands the markdownlint ignore list with rules MD031, MD032, MD034, and MD060.
Terminology fixes:
Key/value→Key-value/key-value(land.md,land_use.md,infrastructure.md,water.md,source_tags.md,schema/index.md)TODO→Todo(land.md)websites→sitesin description text (place.md)# Id→# ID(ref/id.md)snake case→snake_case(2 occurrences insnake_case_string.md).markdownlint.jsonadditions:MD031,MD032,MD034,MD060Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.