Skip to content

docs: improve onboarding UX, navigation and beginner examples (#12032)#12349

Open
azmaldev wants to merge 2 commits intocontinuedev:mainfrom
azmaldev:main
Open

docs: improve onboarding UX, navigation and beginner examples (#12032)#12349
azmaldev wants to merge 2 commits intocontinuedev:mainfrom
azmaldev:main

Conversation

@azmaldev
Copy link
Copy Markdown

@azmaldev azmaldev commented May 9, 2026

Description

[ What changed? Feel free to be brief. ]

AI Code Review

  • Team members only: AI review runs automatically when PR is opened or marked ready for review
  • Team members can also trigger a review by commenting @continue-review

Checklist

  • [] I've read the contributing guide
  • [] The relevant docs, if any, have been updated or created
  • [] The relevant tests, if any, have been updated or created

Screen recording or screenshot

[ When applicable, please include a short screen recording or screenshot - this makes it much easier for us as contributors to review and understand your changes. See this PR as a good example. ]

Tests

[ What tests were added or updated to ensure the changes work as expected? ]


Summary by cubic

Improves onboarding with a clearer “Start Here” flow, beginner-friendly examples, and streamlined FAQs so new users can write and run their first checks faster. Adds Prettier tooling to keep docs formatting consistent.

  • New Features

    • Home page: “Start Here” with 3-step install/write/run, visual review flow, key concepts, common questions, and help link.
    • Checks quickstart: “Before You Begin,” AI generation via writing-checks (npx skills add continuedev/skills --skill writing-checks), manual template, and realistic before/after examples (Security Review, Test Coverage).
    • FAQs: Reorganized into Getting Started and Troubleshooting with concrete YAML/CLI examples, SSL guidance (requestOptions.caBundlePath, win-ca), Agent mode/tool capability tips, Ollama/WSL/remote setup, secrets via .env, MCP fixes, keyboard shortcuts, and reset steps.
    • Navigation: Adds global “Start Here” anchor in docs.json; clarifies CI flow using continue/check and links to setup pages.
  • Dependencies

    • Docs tooling: add prettier and prettier-plugin-tailwindcss; apply formatting fixes.

Written for commit 9739db4. Summary will update on new commits.

@azmaldev azmaldev requested a review from a team as a code owner May 9, 2026 06:47
@azmaldev azmaldev requested review from sestinj and removed request for a team May 9, 2026 06:47
@dosubot dosubot Bot added the size:XL This PR changes 500-999 lines, ignoring generated files. label May 9, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 9, 2026

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

@azmaldev
Copy link
Copy Markdown
Author

azmaldev commented May 9, 2026

I have read the CLA Document and I hereby sign the CLA

Copy link
Copy Markdown
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 4 files

Prompt for AI agents (unresolved 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:46">
P3: The flow diagram uses `.checks/` instead of `.continue/checks/`, which is inconsistent with the rest of the page and may mislead new users.</violation>
</file>

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

<violation number="1" location="docs/checks/quickstart.mdx:166">
P3: Missing trailing newline at end of file.</violation>
</file>

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

<violation number="1" location="docs/faqs.mdx:268">
P2: Typo in `.wslconfig` section header: `[wsL2]` should be `[wsl2]` (lowercase 'l', not uppercase 'L'). WSL's INI parser treats section headers as case-sensitive, so `[wsL2]` would be silently ignored, breaking the documented workaround for mirrored networking mode.</violation>

<violation number="2" location="docs/faqs.mdx:458">
P2: The docs use the wrong config key here: `verifySsl` should be nested under `requestOptions`, otherwise users will try an invalid setting.</violation>
</file>

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

Comment thread docs/faqs.mdx

You can also join [GitHub Discussions](https://github.com/continuedev/continue/discussions) for additional support. Alternatively, you can create a GitHub issue [here](https://github.com/continuedev/continue/issues/new?assignees=&labels=bug&projects=&template=bug-report-%F0%9F%90%9B.md&title=), providing details of your problem, and we'll be able to help you out more quickly.
<Tip>
As a temporary debug step, set `verifySsl: false`. Do not leave this disabled in production.
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot May 9, 2026

Choose a reason for hiding this comment

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

P2: The docs use the wrong config key here: verifySsl should be nested under requestOptions, otherwise users will try an invalid setting.

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

<comment>The docs use the wrong config key here: `verifySsl` should be nested under `requestOptions`, otherwise users will try an invalid setting.</comment>

<file context>
@@ -332,47 +358,102 @@ models:
 
-You can also join [GitHub Discussions](https://github.com/continuedev/continue/discussions) for additional support. Alternatively, you can create a GitHub issue [here](https://github.com/continuedev/continue/issues/new?assignees=&labels=bug&projects=&template=bug-report-%F0%9F%90%9B.md&title=), providing details of your problem, and we'll be able to help you out more quickly.
+<Tip>
+  As a temporary debug step, set `verifySsl: false`. Do not leave this disabled in production.
+</Tip>
\ No newline at end of file
</file context>
Suggested change
As a temporary debug step, set `verifySsl: false`. Do not leave this disabled in production.
As a temporary debug step, set `requestOptions.verifySsl: false`. Do not leave this disabled in production.
Fix with Cubic

Comment thread docs/faqs.mdx
Create or edit `%UserProfile%\.wslconfig`:
```ini
[wsl2]
[wsL2]
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot May 9, 2026

Choose a reason for hiding this comment

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

P2: Typo in .wslconfig section header: [wsL2] should be [wsl2] (lowercase 'l', not uppercase 'L'). WSL's INI parser treats section headers as case-sensitive, so [wsL2] would be silently ignored, breaking the documented workaround for mirrored networking mode.

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

<comment>Typo in `.wslconfig` section header: `[wsL2]` should be `[wsl2]` (lowercase 'l', not uppercase 'L'). WSL's INI parser treats section headers as case-sensitive, so `[wsL2]` would be silently ignored, breaking the documented workaround for mirrored networking mode.</comment>

<file context>
@@ -173,59 +238,52 @@ models:
 Create or edit `%UserProfile%\.wslconfig`:
 ```ini
-[wsl2]
+[wsL2]
 networkingMode=mirrored

</file context>


</details>

```suggestion
[wsl2]
Fix with Cubic

Comment thread docs/index.mdx
Continue reads
your .checks/ files
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot May 9, 2026

Choose a reason for hiding this comment

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

P3: The flow diagram uses .checks/ instead of .continue/checks/, which is inconsistent with the rest of the page and may mislead new users.

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

<comment>The flow diagram uses `.checks/` instead of `.continue/checks/`, which is inconsistent with the rest of the page and may mislead new users.</comment>

<file context>
@@ -6,13 +6,58 @@ Continue runs AI checks on every pull request. Each check is a markdown file in
+       │
+       ▼
+  Continue reads
+  your .checks/ files
+       │
+       ▼
</file context>
Suggested change
your .checks/ files
your .continue/checks/ files
Fix with Cubic

@@ -2,21 +2,34 @@
title: "Write Your First Check"
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot May 9, 2026

Choose a reason for hiding this comment

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

P3: Missing trailing newline at end of file.

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 166:

<comment>Missing trailing newline at end of file.</comment>

<file context>
@@ -38,13 +51,116 @@ If none of these issues are found, pass the check.
     Set up GitHub integration so checks run on every pull request.
   </Card>
-</CardGroup>
+</CardGroup>
\ No newline at end of file
</file context>
Suggested change
title: "Write Your First Check"
</CardGroup>
Fix with Cubic

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

Labels

size:XL This PR changes 500-999 lines, ignoring generated files.

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

1 participant