Skip to content

Comments

docs: align checks + index with positioning and messaging#10757

Open
TyDunn wants to merge 2 commits intomainfrom
docs/align-positioning-messaging
Open

docs: align checks + index with positioning and messaging#10757
TyDunn wants to merge 2 commits intomainfrom
docs/align-positioning-messaging

Conversation

@TyDunn
Copy link
Contributor

@TyDunn TyDunn commented Feb 23, 2026

Summary

  • Rewrites docs/index.mdx to 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.")
  • Removes all 35 em dashes across docs/index.mdx and 5 checks pages, replacing with colons, periods, or semicolons per the anti-patterns guide
  • Tightens phrasing in best-practices.mdx (line 88: "are most valuable for" → "handle"; "that aren't codified in a linter rule" → "no linter rule can express")

Files changed

File Changes
docs/index.mdx Full rewrite with positioning language, removed 1 em dash
docs/checks/best-practices.mdx Removed ~25 em dashes, tightened tone
docs/checks/running-locally.mdx Removed 2 em dashes
docs/checks/running-in-ci.mdx Removed 1 em dash
docs/checks/generating-checks.mdx Removed 4 em dashes
docs/checks/iterating.mdx Removed 3 em dashes

Test plan

  • grep -r '—' docs/index.mdx docs/checks/ confirms zero em dashes remain
  • cd docs && npx mintlify dev to verify pages render correctly
  • Read each modified page for tone: pragmatic, developer-to-developer, no corporate slop

🤖 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.

  • Docs
    • Rewrote docs/index.mdx to lead with “Your tests pass. But standards slip.”, adopt standards-as-checks messaging, clarify status check behavior, restore .continue/checks/ mention, and remove the “consistency over breadth” line.
    • Replaced em dashes with colons/periods/semicolons and tightened phrasing across checks docs (best-practices, generating-checks, iterating, running-locally, running-in-ci).

Written for commit 211ffe2. Summary will update on new commits.

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>
@TyDunn TyDunn requested a review from a team as a code owner February 23, 2026 23:47
@TyDunn TyDunn requested review from Patrick-Erichsen and removed request for a team February 23, 2026 23:47
@dosubot dosubot bot added the size:M This PR changes 30-99 lines, ignoring generated files. label Feb 23, 2026
@haystack-code-reviewer-pr-hook

Try Haystack Code Reviewer

Want AI-powered code review for this PR? Get instant analysis, interactive visualizations, and actionable insights.

Review this PR with Haystack

Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

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

No issues found across 6 files

…s/ mention

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
## 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.
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't love "reviewable alongside your code". How it works should be matter-of-fact

"The AI" I also don't like

@github-project-automation github-project-automation bot moved this from Todo to In Progress in Issues and PRs Feb 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:M This PR changes 30-99 lines, ignoring generated files.

Projects

Status: In Progress

Development

Successfully merging this pull request may close these issues.

2 participants