Skip to content

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 platforms.
    • Enhanced Quickstart with a new "Advanced Script" example (collapsible).
    • Reordered and repositioned tips in the intro and quickstart.
    • Revised product intro with a new "Why Notte?" section and refined messaging.
    • Reorganized key features into clearer, categorized sections.

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

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

  • Heterogeneous documentation changes: two new integration guides plus rewrites to core intro and quickstart.
  • Review should focus on technical accuracy of code examples, consistency of terminology and attribute names, and navigation updates in docs.json.
  • Files meriting extra attention:
    • docs/src/integrations/kernel.mdx — verify Kernel CDP usage, auth/token handling, and sample code correctness.
    • docs/src/integrations/steel.mdx — verify Steel CDP examples and parameters.
    • docs/src/intro/what-is-notte.mdx and docs/src/intro/quickstart.mdx — check content flow, examples, and any moved tips or instructions.
    • docs/src/docs.json — ensure navigation ordering and paths are correct.

Possibly related PRs

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 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 and Steel integration guides, improve intro content" directly and specifically addresses all the major changes in this pull request. It explicitly mentions the two new integration guides being added (Kernel and Steel) and references the improvements made to introductory content (what-is-notte.mdx and quickstart.mdx). The title is concise, avoids vague terminology, and provides sufficient specificity that a reviewer scanning the git history would understand the primary changes. The supporting change to docs.json (navigation updates) is implicitly covered as part of adding the new integration guides.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs-improvements-clean

📜 Recent 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 64b1eb9 and fdbd5ca.

📒 Files selected for processing (2)
  • docs/src/intro/quickstart.mdx (2 hunks)
  • docs/src/intro/what-is-notte.mdx (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/src/intro/quickstart.mdx
⏰ 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/intro/what-is-notte.mdx (4)

6-6: Grammar fix applied.

The past review comment requesting the correction from "stealthily" to "stealthy" has been applied correctly. The phrase now properly uses the adjective "stealthy" to modify "cloud browser sessions."


8-13: New "Why Notte?" section clarifies value proposition well.

The section effectively articulates the core differentiator: the ability to combine deterministic scripts with autonomous agents. The explanation about moving from prototype to production without managing separate infrastructure directly supports the PR objective of enhancing the value proposition.


28-45: Key Features reorganization improves scannability and structure.

Grouping features under Web Automation, Browser infrastructure, and Security & Identity categories makes the platform's capabilities easier to scan and understand. Each section is well-organized with clear headings and descriptive bullet points.


6-6: All internal documentation links are valid and correctly reference existing pages.

Verification confirmed that all 11 unique internal documentation paths in the file point to existing .mdx files:

  • /concepts/ (6 links): agents, operations, personas, sessions, vaults, workflows
  • /intro/ (2 links): quickstart, python-sdk
  • /integrations/ (1 link): mcp
  • /sdk-reference/ (1 link): manual

No broken, orphaned, or incorrectly referenced links were found. All linked documentation pages exist and have not been moved or renamed.


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.

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.

2 participants