Skip to content

[WIP] update docs to reflect checks#10489

Merged
sestinj merged 9 commits intomainfrom
nate/docs-updates-5
Feb 17, 2026
Merged

[WIP] update docs to reflect checks#10489
sestinj merged 9 commits intomainfrom
nate/docs-updates-5

Conversation

@sestinj
Copy link
Contributor

@sestinj sestinj commented Feb 13, 2026

Summary

  • Restructured docs navigation: split "Documentation" tab into "Mission Control" and "CLI" tabs
  • Moved guides into their respective tabs (Understanding Continue → IDE Extensions)
  • Removed Guides tab, Cloud Agents guides, Continuous AI guides, Cookbooks, and Integration Guides from nav
  • Added "Continue Hub (deprecated)" section to IDE Extensions for Secrets and Configs
  • Added redirects for removed/moved pages

Test plan

  • Verify all nav links resolve correctly
  • Check redirects for removed pages work

🤖 Generated with Claude Code


Summary by cubic

Shifted the docs to focus on source-controlled PR checks with a dedicated Checks tab, concise integration pages, and end-to-end guides for writing and running checks locally or in CI. Adds a docs style guide skill and a new repository check for stale/misleading comments.

  • New Features

    • Checks docs: Quickstart, Generating Checks, Best Practices, Reference, Running Locally, Running in CI.
    • CLI docs: Quickstart, TUI Mode, Headless Mode, Configuration, Tool Permissions.
    • Mission Control: “Beyond Checks” page for agents and triggers beyond PRs.
    • New docs style guide skill and a Stale & Misleading Comments check in .continue/checks/.
  • Refactors

    • Navigation: replace “Documentation” with “Checks”; add “Writing Checks”; update homepage copy/links.
    • Simplified integration pages with clear “Connect” flows (GitHub, Slack, Sentry, Snyk, Netlify, Sanity, Supabase, PostHog, Atlassian).
    • Removed legacy CLI pages and stale guides; updated redirects.
    • Minor README formatting fix to pass Prettier.

Written for commit c083672. Summary will update on new commits.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@dosubot dosubot bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Feb 13, 2026
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 2 files

- Add .claude/skills/docs-style/SKILL.md with tone, heading, and structure rules
- Add docs/cli/tui-mode.mdx as first page in new CLI tab structure
- Clean up overview.mdx frontmatter (title = sidebar title, drop description)
@sestinj sestinj requested a review from a team as a code owner February 13, 2026 17:25
@sestinj sestinj requested review from RomneyDa and removed request for a team February 13, 2026 17:25
New pages:
- cli/overview — concise intro, install snippet, two-mode summary, flags table
- cli/install — install, auth (login, API key, local key), requirements
- cli/tui-mode — interactive session, @context, slash commands, resume, tool permissions
- cli/headless-mode — -p flag, piping, output options, CI auth, examples
- cli/configuration — config resolution, --config, /config, config.yaml, CLI flags, secrets
- cli/tool-permissions — permission levels, defaults, flags, patterns, permissions.yaml, precedence, modes

Removed:
- cli/quick-start — content distributed into mode-specific pages
- cli/guides — stale redirect

Updated docs.json navigation to match new structure.
@dosubot dosubot bot added size:XXL This PR changes 1000+ lines, ignoring generated files. and removed size:L This PR changes 100-499 lines, ignoring generated files. labels Feb 13, 2026
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.

4 issues found across 34 files (changes from recent commits).

Prompt for AI agents (all issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="docs/index.mdx">

<violation number="1" location="docs/index.mdx:5">
P2: Clarify that checks execute on the GitHub Actions runner to avoid implying PR diffs are processed externally.

(Based on your team's feedback about clarifying that review processing runs on the GitHub Actions runner, not Continue Hub.) [FEEDBACK_USED]</violation>
</file>

<file name="docs/checks/setup-on-continue.mdx">

<violation number="1" location="docs/checks/setup-on-continue.mdx:46">
P3: Clarify that the self-hosted option executes on the GitHub Actions runner so readers don’t infer the checks run in Continue Hub.

(Based on your team's feedback about clarifying that review processing runs on the GitHub Actions runner, not Continue Hub.) [FEEDBACK_USED]</violation>
</file>

<file name=".continue/checks/react-performance.md">

<violation number="1" location=".continue/checks/react-performance.md:24">
P3: The Promise.all example still makes three requests; calling it “1 round trip” is inaccurate and could mislead readers. Clarify that the requests run in parallel instead.</violation>
</file>

<file name="docs/agents/overview.mdx">

<violation number="1" location="docs/agents/overview.mdx:14">
P2: This line incorrectly implies local agents run on Continue’s cloud infrastructure. The local agents guide says they execute locally via the CLI or on GitHub Actions runners, so this statement is misleading.</violation>
</file>

Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.

Reference the writing-checks and check skills from the continuedev/skills
repo on the generating checks and run locally docs pages.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Rename checks pages for clarity (writing-good-checks -> best-practices,
examples -> generating-checks, setup-on-continue -> running-in-ci).
Update navigation, integration pages, and homepage content.
Remove unused check files and add stale-comments check.

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

1 issue found across 26 files (changes from recent commits).

Prompt for AI agents (all issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="docs/checks/quickstart.mdx">

<violation number="1" location="docs/checks/quickstart.mdx:45">
P3: The quickstart now uses `/check`, but the Generating Checks guide still documents `/checks` with examples. This inconsistency will confuse users about the correct command; align the command name across these docs.</violation>
</file>

Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.


<CardGroup cols={2}>
<Card title="Run Locally" icon="terminal" href="/checks/running-locally">
Verify your checks before pushing by running `/check` in your coding agent.
Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot Feb 17, 2026

Choose a reason for hiding this comment

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

P3: The quickstart now uses /check, but the Generating Checks guide still documents /checks with examples. This inconsistency will confuse users about the correct command; align the command name across these docs.

Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs/checks/quickstart.mdx, line 45:

<comment>The quickstart now uses `/check`, but the Generating Checks guide still documents `/checks` with examples. This inconsistency will confuse users about the correct command; align the command name across these docs.</comment>

<file context>
@@ -42,21 +36,15 @@ Flag as failing if any of these are true:
 <CardGroup cols={2}>
   <Card title="Run Locally" icon="terminal" href="/checks/running-locally">
-    Verify your checks before pushing by running `/checks` in your coding agent.
+    Verify your checks before pushing by running `/check` in your coding agent.
   </Card>
-  <Card title="Run Checks in CI" icon="github" href="/checks/setup-on-continue">
</file context>
Fix with Cubic

@sestinj sestinj merged commit 70bde7f into main Feb 17, 2026
42 of 43 checks passed
@sestinj sestinj deleted the nate/docs-updates-5 branch February 17, 2026 07:29
@github-project-automation github-project-automation bot moved this from Todo to Done in Issues and PRs Feb 17, 2026
@github-actions github-actions bot locked and limited conversation to collaborators Feb 17, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

size:XXL This PR changes 1000+ lines, ignoring generated files.

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant