Skip to content

docs: retire the STYLE-CHECK convention - #831

Merged
saif-at-scalekit merged 1 commit into
mainfrom
docs/retire-style-check-convention
Jul 3, 2026
Merged

docs: retire the STYLE-CHECK convention#831
saif-at-scalekit merged 1 commit into
mainfrom
docs/retire-style-check-convention

Conversation

@ekline

@ekline ekline Bot commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

What & why

A reviewer on #818 asked that the STYLE-CHECK marker no longer be committed to the repo, that existing occurrences be removed, and that CodeRabbit stop enforcing it. This PR handles the repo-level part of that request.

Changes

  • .coderabbit.yaml — removed the rule under the CLAUDE.md path instructions that required every AI-generated draft to end with STYLE-CHECK: [PASSED | TODO]. CodeRabbit will no longer enforce the marker on future PRs.
  • src/content/docs/cookbooks/add-hosted-auth-nextjs-app-router.mdx — removed a bare STYLE-CHECK: PASSED line that was committed at the end of the page. Because it was not wrapped in an MDX comment, it rendered as visible text on the published page.

Related PRs

The same marker was introduced on three in-flight docs PRs; each has a follow-up commit removing it:

Verification

  • Repo-wide search confirms no STYLE-CHECK occurrences remain in src/, .coderabbit.yaml, CLAUDE.md, or AGENTS.md on this branch.
  • developer-docs/CLAUDE.md and AGENTS.md were checked and do not mention STYLE-CHECK (the "Quality Checklist" section never referenced it), so no edit was needed there.

Out of scope

The monorepo-root CLAUDE.md (outside this git repository) still contains a STYLE-CHECK convention line. It cannot be changed from a developer-docs PR — flagging it so whoever owns that file can update it separately.

Preview: https://deploy-preview-{PR_NUMBER}--scalekit-starlight.netlify.app/cookbooks/add-hosted-auth-nextjs-app-router/

ekline[bot] <202747777+ekline[bot]@users.noreply.github.com>

Stop enforcing the STYLE-CHECK marker in CodeRabbit and remove the marker that was rendering as visible text on the hosted-auth Next.js cookbook. Per reviewer request on PR #818: STYLE-CHECK markers should not be committed going forward.

ekline[bot] <202747777+ekline[bot]@users.noreply.github.com>
@saif-at-scalekit
saif-at-scalekit merged commit 2666d5c into main Jul 3, 2026
@saif-at-scalekit
saif-at-scalekit deleted the docs/retire-style-check-convention branch July 3, 2026 07:21
@netlify

netlify Bot commented Jul 3, 2026

Copy link
Copy Markdown

Deploy Preview for scalekit-starlight ready!

Name Link
🔨 Latest commit 418080b
🔍 Latest deploy log https://app.netlify.com/projects/scalekit-starlight/deploys/6a47619e6f33d700087c8e71
😎 Deploy Preview https://deploy-preview-831--scalekit-starlight.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 64 (🟢 up 26 from production)
Accessibility: 98 (no change from production)
Best Practices: 92 (no change from production)
SEO: 92 (no change from production)
PWA: -
View the detailed breakdown and full score reports
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant