docs: recommend Notte skill workflow#814
Conversation
WalkthroughThis PR updates the onboarding documentation across three files to revise the recommended setup workflow. The changes promote a two-phase approach: first using the Notte skill for browser flow discovery and validation on live pages, then transitioning to the SDK once the workflow is known and repeatable. The banner in docs.json, intro guidance in index.mdx, and quickstart instructions in quickstart.mdx all receive updated messaging aligned with this workflow recommendation. Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/src/docs.json (1)
16-16: ⚡ Quick winConsider reordering the banner for clearer user flow.
The current banner mentions "start with the [Notte skill]... then automate with the SDK; install it with..." This presents the steps out of logical order (skill → SDK → install skill). Users would naturally expect: install → use → then automate.
Additionally, "install it" is ambiguous—readers may wonder whether "it" refers to the skill or SDK.
✍️ Proposed rewording for clearer flow
- "content": "Recommended workflow: start with the [Notte skill](https://github.com/nottelabs/notte-skills/), then automate with the SDK; install it with `npx skills add nottelabs/notte-skills` | [Setup guide](/integrations/claude-code-ai-agents)", + "content": "Recommended workflow: install the [Notte skill](https://github.com/nottelabs/notte-skills/) with `npx skills add nottelabs/notte-skills` to explore browser flows, then automate with the SDK | [Setup guide](/integrations/claude-code-ai-agents)",🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/src/docs.json` at line 16, Reorder and reword the "content" string in docs.json so the user flow is install → try → automate: first tell users to install the Notte skill (explicitly name the skill, e.g., "install the Notte skill with `npx skills add nottelabs/notte-skills`"), then say "start with the Notte skill" (or "try the Notte skill") and finally mention automating with the SDK ("then automate with the SDK"). Update the sentence assigned to the "content" key to remove the ambiguous "install it" pronoun and make each step explicit and sequential.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@docs/src/docs.json`:
- Line 16: Reorder and reword the "content" string in docs.json so the user flow
is install → try → automate: first tell users to install the Notte skill
(explicitly name the skill, e.g., "install the Notte skill with `npx skills add
nottelabs/notte-skills`"), then say "start with the Notte skill" (or "try the
Notte skill") and finally mention automating with the SDK ("then automate with
the SDK"). Update the sentence assigned to the "content" key to remove the
ambiguous "install it" pronoun and make each step explicit and sequential.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 0e4e6e71-f0f9-4e6e-b0e2-acf3b894fd17
📒 Files selected for processing (3)
docs/src/docs.jsondocs/src/index.mdxdocs/src/quickstart.mdx
|
| Filename | Overview |
|---|---|
| docs/src/docs.json | Banner text updated to recommend the two-phase skill → SDK workflow; new text contains a slightly ambiguous "it" pronoun but no functional issues. |
| docs/src/index.mdx | Human-facing Tip block and "Getting Started" intro revised to recommend the Notte skill for exploration before using the SDK; agent-facing block left unchanged. |
| docs/src/quickstart.mdx | Human Tip block updated; line 66 now references "the CLI" without any prior mention of a CLI tool in the human-visible section, creating a dangling reference. |
Prompt To Fix All With AI
Fix the following 2 code review issues. Work through them one at a time, proposing concise fixes.
---
### Issue 1 of 2
docs/src/quickstart.mdx:66
After this PR's edits, the human-visible `<Visibility for="humans">` Tip block no longer mentions any CLI tool — it only links to the Notte skill GitHub repo. The sentence below therefore leaves "the CLI" undefined for human readers. Replacing it with "the Notte skill" keeps the reference consistent with what was introduced above.
```suggestion
Both Python and JavaScript quickstarts below use the official Notte SDK. Start with Browser Session if you already know the flow you want to automate, or after you have validated it with the [Notte skill](https://github.com/nottelabs/notte-skills/).
```
### Issue 2 of 2
docs/src/docs.json:16
The pronoun "it" in "install it with `npx skills add nottelabs/notte-skills`" has two possible referents in the sentence — the Notte skill and the SDK. Replacing "it" with "the skill" removes the ambiguity.
```suggestion
"content": "Recommended workflow: start with the [Notte skill](https://github.com/nottelabs/notte-skills/), then automate with the SDK; install the skill with `npx skills add nottelabs/notte-skills` | [Setup guide](/integrations/claude-code-ai-agents)",
```
Reviews (1): Last reviewed commit: "docs: recommend Notte skill workflow" | Re-trigger Greptile
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
✅ Eval complete for commit
Ran evals with prompts: 📈 +0.9 pts · Getting Started — B (78.6/100) from B (77.7) · View metricsPrompt text:
Verdict:
Friction points:
Result: B (78.6/100) delta vs baseline: +0.9 pts
Stats: 1m 58s · 25 tool calls · 0 errors · $1.36 Evaluating agent experience using 2027.dev · View dashboard |
![mendral-app[bot]](https://avatars.githubusercontent.com/in/1975249?s=60&v=4){kind=small}
There was a problem hiding this comment.
LGTM
Pure documentation copy changes with no security, correctness, or data-loss concerns. The messaging is clear and consistent across all three files.
Tag @mendral-app with feedback or questions. View session
|
Superseded by #815, which includes this commit plus the follow-up quickstart and snippet updates in one PR. |
1 participant
Summary
Checks
Summary by CodeRabbit
Note
Updates docs banner, index, and quickstart copy to recommend starting with the Notte skill for exploration before moving to the SDK for repeatable automation. Removes the inline bash install snippet from two pages and replaces it with prose linking to the notte-skills GitHub repo.
Written by Mendral for commit 56f67e5.