Skip to content

docs: add Kernel guide + improved doc/intro content#607

Open
sam-notte wants to merge 3 commits intomainfrom
docs-improvements-clean
Open

docs: add Kernel guide + improved doc/intro content#607
sam-notte wants to merge 3 commits intomainfrom
docs-improvements-clean

Conversation

@sam-notte
Copy link
Contributor

@sam-notte sam-notte commented Oct 27, 2025

  • 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

Summary by CodeRabbit

  • Documentation
    • Added integration guides for Kernel and Steel CDP with usage examples and troubleshooting.
    • Enhanced Quickstart with a new "Advanced Script" example (collapsible).
    • Reordered and repositioned tips in intro and quickstart.
    • Revised product intro with a new "Why Notte?" section and refined messaging.
    • Reorganized key features into clearer, categorized sections.

✏️ Tip: You can customize this high-level summary in your review settings.

- 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
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 27, 2025

Walkthrough

This 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, a "Why Notte?" section, and reorganized key features).

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: add Kernel guide + improved doc/intro content' accurately captures the main changes: addition of Kernel integration documentation and improvements to documentation/intro content. It is clear, concise, and directly related to the primary changes in the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

📥 Commits

Reviewing files that changed from the base of the PR and between e95b4aa and 64b1eb9.

📒 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.

updated links
@sam-notte sam-notte changed the title docs: add Kernel and Steel integration guides, improve intro content docs: add Kernel guide + improved doc/intro content Jan 29, 2026
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@docs/src/integrations/steel.mdx`:
- Line 77: Remove the trailing space at the end of the line containing the
"[Proxies](https://docs.notte.cc/features/sessions/proxies)" link in
docs/src/integrations/steel.mdx; open that line (the one matching the
"[Proxies]" link text), delete the trailing whitespace character, save the file,
and re-run the pre-commit hooks to confirm the fix.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant