docs: update of the readme

[Yggdrasill501]

Summary by CodeRabbit

• Documentation
  • Full README overhaul: new cover image, badges, project showcase, and multi-section marketing/documentation layout for VS Code, Cursor, and Windsurf.
  • Added Getting Started walkthrough, expanded Usage and Command Palette guidance, Database integrations and SQL blocks how-tos, developer quick-start, license, support/issue links, and a branded footer.

[linear]

MAR-247 Readme deepnote/vscode-deepnote

[coderabbitai]

Warning

Rate limit exceeded

@jamesbhobbs has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 11 minutes and 23 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between e2a1545 and 2d337e9.

⛔ Files ignored due to path filters (1)

• deepnote-vscode-cover-image.png is excluded by !**/*.png

📒 Files selected for processing (1)

• README.md (1 hunks)

📝 Walkthrough

Walkthrough

README.md was rewritten into a feature-focused guide for the Deepnote multi-editor experience (VS Code, Cursor, Windsurf). The header was replaced with a cover image and badges. New sections include Requirements (VS Code, Python, Node.js), Getting Started, expanded Usage and Command Palette, Database integrations with secure credential handling, Working with SQL Blocks, Quick start for developers, Documentation links, License, support links, and a visual project showcase. No public API or exported declarations changed.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant User
  participant Editor as "Editor (VS Code / Cursor / Windsurf)"
  participant Cmd as "Command Palette"
  participant Ext as "Deepnote Extension"
  participant Kernel as "Deepnote Kernel"
  participant DB as "Database"

  Note over Editor,Ext: Extension provides notebook blocks, SQL blocks,\nDB integrations, commands

  User->>Editor: Open project/notebook
  Editor->>Ext: Activate extension
  User->>Cmd: Invoke command
  Cmd->>Ext: Execute command
  Ext->>Kernel: Load or run block

  alt Connect to DB
    Ext->>User: Prompt for credentials (secure store)
    User->>Ext: Provide credentials
    Ext->>DB: Establish connection
    DB-->>Ext: OK / error
  end

  alt Run SQL block
    User->>Ext: Run SQL block
    Ext->>DB: Execute query
    DB-->>Ext: Return rows / error
    Ext->>Kernel: Render results
    Kernel-->>User: Display results
  else Run code block
    User->>Ext: Run code block
    Ext->>Kernel: Execute code
    Kernel-->>User: Output / visualization
  end

Loading

Suggested reviewers

• Artmann
• saltenasl

Pre-merge checks

❌ Failed checks (1 warning, 1 inconclusive)

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.
Title Check	❓ Inconclusive	The title "docs: update of the readme" is technically related to the changeset since the README.md file was indeed updated. However, the phrasing is vague and generic—it could describe almost any README modification, from fixing a typo to a complete rewrite. Given that the actual changes are substantial (comprehensive restructuring with new sections for Getting Started, Usage, Database integrations, SQL blocks, and expanded documentation), the title fails to convey what specifically changed. A teammate scanning commit history would learn only that something changed in the README, not what that something is.	Consider revising the title to be more descriptive of the main change, such as "docs: restructure README with getting started and usage guides" or "docs: add comprehensive documentation sections to README". This would help clarify the scope and nature of the update for reviewers and future reference.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

---

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

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e2fa9b5 and 1d26875.

⛔ Files ignored due to path filters (1)

• deepnote-dragon.png is excluded by !**/*.png

📒 Files selected for processing (1)

• README.md (1 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

README.md

1-1: First line in a file should be a top-level heading

(MD041, first-line-heading, first-line-h1)

🔇 Additional comments (3)

README.md (3)

48-48: Verify VS Code version requirement.

VS Code 1.103.0 seems unusually high. Confirm this is the intended minimum version; typical stable releases are in the 1.9x range.

---

137-142: Documentation links verified—all files exist.

All referenced documentation files are present in the repository: architecture.md, DEEPNOTE_KERNEL_IMPLEMENTATION.md, INTEGRATIONS_CREDENTIALS.md, and CONTRIBUTING.md. The README.md links are valid.

---

79-81: Commands are implemented. All three commands are registered in the codebase:

• 'deepnote.newProject' (src/notebooks/deepnote/deepnoteExplorerView.ts:60)
• 'deepnote.importNotebook' (src/notebooks/deepnote/deepnoteExplorerView.ts:64)
• Commands.ManageIntegrations (src/notebooks/deepnote/integrations/integrationManager.ts:33)

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 73%. Comparing base (137d31b) to head (2d337e9).
⚠️ Report is 1 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files

@@          Coverage Diff          @@
##            main    #117   +/-   ##
=====================================
  Coverage     73%     73%           
=====================================
  Files        548     548           
  Lines      43272   43272           
  Branches    5256    5256           
=====================================
  Hits       31590   31590           
  Misses      9942    9942           
  Partials    1740    1740           

🚀 New features to boost your workflow:

• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[coderabbitai]

Actionable comments posted: 2

♻️ Duplicate comments (1)

README.md (1)

1-1: Add H1 heading as first line to comply with MD041.

This linting violation was flagged in the previous review. The file must start with a top-level heading, and the image should follow:

+# Deepnote VS Code Extension
+
-![Deepnote dragon](deepnote-dragon.png) <!--- This is just placeholder for deepnote + vscodde logo --->
+![Deepnote dragon](deepnote-dragon.png) <!--- This is just placeholder for deepnote + vscode logo --->

This also fixes the typo vscodde → vscode in the comment.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1d26875 and 837d120.

⛔ Files ignored due to path filters (1)

• deepnote-dragon.png is excluded by !**/*.png

📒 Files selected for processing (1)

• README.md (1 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

README.md

1-1: First line in a file should be a top-level heading

(MD041, first-line-heading, first-line-h1)

---

14-14: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above

(MD022, blanks-around-headings)

---

14-14: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

⏰ 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). (3)

• GitHub Check: Build & Package Extension
• GitHub Check: Build & Test
• GitHub Check: Lint & Format

🔇 Additional comments (1)

README.md (1)

8-122: Comprehensive documentation improvements — well structured.

The expanded README significantly improves the extension's onboarding experience with clear sections on features, requirements, getting started, usage, and developer resources. The promotional tone is appropriate and the technical content is accurate. Structure and formatting are professional once the linting issues above are resolved.

[Yggdrasill501]

@jamesbhobbs Should I rebase with main before merge?

[coderabbitai]

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

Disabled knowledge base sources:

• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 0ad13c4 and d19c8a7.

⛔ Files ignored due to path filters (1)

• deepnote-vscode-cover-image.png is excluded by !**/*.png

📒 Files selected for processing (1)

• README.md (1 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

README.md

1-1: First line in a file should be a top-level heading

(MD041, first-line-heading, first-line-h1)

---

14-14: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above

(MD022, blanks-around-headings)

⏰ 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: Build & Test

🔇 Additional comments (1)

README.md (1)

38-53: Clarify that Getting Started is VS Code-specific.

The intro and header prominently feature VS Code, Cursor, and Windsurf equally, but the Getting Started section (lines 40–45) uses only VS Code-specific commands (Cmd+P/Ctrl+P) and links exclusively to the VS Code Marketplace. Users of Cursor or Windsurf may be confused.

Either add editor-specific subsections or note upfront that these steps apply to VS Code (and clarify whether the VS Code marketplace link works for the other editors).

[coderabbitai]

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

Disabled knowledge base sources:

• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between d19c8a7 and a9efe60.

📒 Files selected for processing (1)

• README.md (1 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

README.md

1-1: First line in a file should be a top-level heading

(MD041, first-line-heading, first-line-h1)

---

130-130: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

[jamesbhobbs]

Header still needs changing, will do in another PR

[Artmann]

Shouldn't the default be using the UI?

[jamesbhobbs]

2. Open the extensions tab and Search for Deepnote
3. Or alternatively, press Cmd+P or Ctrl+P to open the command palette.
4. Type `ext install Deepnote.vscode-deepnote