docs: align checks + index with positioning and messaging#10757
Open
docs: align checks + index with positioning and messaging#10757
Conversation
Rewrite index.mdx to lead with the problem statement ("Your tests
pass. But standards slip.") and use canonical positioning language.
Remove all 35 em dashes across checks pages and index, replacing
with colons, periods, or semicolons per the anti-patterns guide.
Tighten phrasing in best-practices.mdx.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
Want AI-powered code review for this PR? Get instant analysis, interactive visualizations, and actionable insights. |
…s/ mention Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
sestinj
requested changes
Feb 24, 2026
| ## How it works | ||
|
|
||
| You define checks as markdown files in `.continue/checks/`. Each file has a name, a description, and a prompt that tells the AI what to look for. | ||
| You define checks as markdown files in `.continue/checks/`, version-controlled and reviewable alongside your code. You specify what to look for. The AI enforces it on every PR. Results show up as GitHub status checks: green if the code looks good, red with a suggested fix if not. |
Contributor
There was a problem hiding this comment.
I don't love "reviewable alongside your code". How it works should be matter-of-fact
"The AI" I also don't like
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.
Summary
docs/index.mdxto lead with the problem statement ("Your tests pass. But standards slip.") and use canonical positioning language ("Standards as checks, enforced by AI, decided by humans.")docs/index.mdxand 5 checks pages, replacing with colons, periods, or semicolons per the anti-patterns guidebest-practices.mdx(line 88: "are most valuable for" → "handle"; "that aren't codified in a linter rule" → "no linter rule can express")Files changed
docs/index.mdxdocs/checks/best-practices.mdxdocs/checks/running-locally.mdxdocs/checks/running-in-ci.mdxdocs/checks/generating-checks.mdxdocs/checks/iterating.mdxTest plan
grep -r '—' docs/index.mdx docs/checks/confirms zero em dashes remaincd docs && npx mintlify devto verify pages render correctly🤖 Generated with Claude Code
Continue Tasks: ❌ 7 failed — View all
Summary by cubic
Aligns the docs homepage and checks pages with updated positioning and clearer language. Rewrites the index to lead with the problem, clarifies that checks are source-controlled status checks, and restores the
.continue/checks/path..continue/checks/mention, and remove the “consistency over breadth” line.Written for commit 211ffe2. Summary will update on new commits.