-
Notifications
You must be signed in to change notification settings - Fork 166
docs: add Kernel and Steel integration guides, improve intro content #607
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
- Add Kernel integration documentation with setup and troubleshooting - Add Steel integration documentation - Enhance what-is-notte with clearer value proposition - Improve quickstart with advanced example
WalkthroughThis pull request updates the documentation site: it adds two new integration pages (docs/src/integrations/kernel.mdx and docs/src/integrations/steel.mdx), updates docs/src/docs.json to include those pages in the Integrations group, augments the quickstart (docs/src/intro/quickstart.mdx) with an "Advanced Script" step and reorders a tip, and restructures and rewrites content in docs/src/intro/what-is-notte.mdx (new intro text, "Why Notte?" section, and reorganized key features). Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes
Possibly related PRs
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
🔇 Additional comments (4)
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 2
🧹 Nitpick comments (1)
docs/src/integrations/kernel.mdx (1)
58-61: Minor style suggestion: Consider rewording line 61 for clarity.The phrase "if they matter for your use case" could be more direct (e.g., "if required for your use case" or "when needed"). This is optional.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
docs/src/docs.json(1 hunks)docs/src/integrations/kernel.mdx(1 hunks)docs/src/integrations/steel.mdx(1 hunks)docs/src/intro/quickstart.mdx(2 hunks)docs/src/intro/what-is-notte.mdx(2 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/src/integrations/kernel.mdx
[style] ~61-~61: To elevate your writing, try using an alternative expression here.
Context: ...ameters during browser creation if they matter for your use case. ## Troubleshooting ...
(MATTERS_RELEVANT)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: tests
🔇 Additional comments (4)
docs/src/docs.json (1)
65-67: LGTM!The integration navigation entries are correctly formatted and reference the new documentation files. The ordering (cursor, kernel, steel) appears intentional and logical.
docs/src/integrations/kernel.mdx (1)
1-77: Excellent integration guide.The Kernel integration documentation is comprehensive, well-structured, and includes appropriate caveats about API compatibility. Code examples are clear and follow Notte SDK patterns correctly.
docs/src/integrations/steel.mdx (1)
1-77: Excellent integration guide with good Steel-specific details.The Steel integration documentation is well-structured and mirrors the Kernel guide appropriately. The guidance on API key handling and query parameters is clear and accurate.
docs/src/intro/what-is-notte.mdx (1)
8-14: Excellent restructuring with clear value proposition.The new "Why Notte?" section effectively explains the platform's approach (combining deterministic scripts with adaptive agents), and the reorganized Key Features into Web Automation, Browser infrastructure, and Security & Identity categories significantly improves readability and navigation.
Summary by CodeRabbit