Repository navigation
Conversation
Adds a Checkly Vale style (check and monitor types, third-party names, single feature instances) and a script that checks headings, frontmatter titles and component titles for sentence case. Both run only on the lines a PR adds or changes, so existing text never fails a PR. The rules are in AGENTS.md under "Casing and terminology"; run them locally with npm run lint:casing. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a casing check to
static-docs-checksthat fails a PR when a line it adds or changes breaks the docs casing rules. Existing text elsewhere in a file never fails the check.Rules (also in
AGENTS.mdunder "Casing and terminology", so agents follow them while writing):title/sidebarTitleand componenttitle="…"use sentence case. Acronyms and mixed-case names pass; other names that keep their capitals are listed instyles/Checkly/proper-nouns.txt.How: a
styles/ChecklyVale style for the term rules, and.github/scripts/check-casing.mjsfor sentence case. Run it locally withnpm run lint:casing, ornpm run lint:casing -- --all <file.mdx>for whole files.Tested:
🤖 Generated with Claude Code