docs: improve onboarding UX, navigation and beginner examples (#12032)#12349
docs: improve onboarding UX, navigation and beginner examples (#12032)#12349azmaldev wants to merge 2 commits intocontinuedev:mainfrom
Conversation
|
All contributors have signed the CLA ✍️ ✅ |
|
I have read the CLA Document and I hereby sign the CLA |
There was a problem hiding this comment.
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.
|
|
||
| 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. |
There was a problem hiding this comment.
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>
| 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. |
| Create or edit `%UserProfile%\.wslconfig`: | ||
| ```ini | ||
| [wsl2] | ||
| [wsL2] |
There was a problem hiding this comment.
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]
| │ | ||
| ▼ | ||
| Continue reads | ||
| your .checks/ files |
There was a problem hiding this comment.
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>
| your .checks/ files | |
| your .continue/checks/ files |
| @@ -2,21 +2,34 @@ | |||
| title: "Write Your First Check" | |||
There was a problem hiding this comment.
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>
| title: "Write Your First Check" | |
| </CardGroup> | |
Description
[ What changed? Feel free to be brief. ]
AI Code Review
@continue-reviewChecklist
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
writing-checks(npx skills add continuedev/skills --skill writing-checks), manual template, and realistic before/after examples (Security Review, Test Coverage).requestOptions.caBundlePath, win-ca), Agent mode/tool capability tips, Ollama/WSL/remote setup, secrets via.env, MCP fixes, keyboard shortcuts, and reset steps.docs.json; clarifies CI flow usingcontinue/checkand links to setup pages.Dependencies
prettierandprettier-plugin-tailwindcss; apply formatting fixes.Written for commit 9739db4. Summary will update on new commits.