feat: Add a walkthrough by Artmann · Pull Request #321 · deepnote/vscode-deepnote

Artmann · 2026-02-17T08:57:19Z

Fixes #317

Summary by CodeRabbit

New Features
- Added an interactive "Deepnote Welcome" onboarding walkthrough with four guided steps: explore projects, work with notebook blocks, connect data sources, and set up a Python environment — each with step-specific instructions and visual aids.
Documentation
- Added localized titles, descriptions, and image alt text for the walkthrough and its steps.

coderabbitai · 2026-02-17T08:57:40Z

No actionable comments were generated in the recent review. 🎉

📝 Walkthrough

Walkthrough

A walkthrough manifest for Deepnote onboarding has been added to the extension. The package.json defines a new walkthrough with id "deepnoteWelcome" containing four sequential steps: exploring projects, working with notebook blocks, connecting data sources, and setting up a Python environment. Each step includes media assets and completion events. Corresponding localization strings are added to package.nls.json to support the walkthrough titles, descriptions, and media alt-text across the four steps.

🚥 Pre-merge checks | ✅ 5 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Updates Docs	❓ Inconclusive	PR implements walkthrough feature but no documentation updates are visible in tracked changes.	Verify documentation updates in deepnote/deepnote OSS and deepnote/deepnote-internal repositories.

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'feat: Add a walkthrough' directly describes the main change—adding a walkthrough feature to the extension.
Linked Issues check	✅ Passed	The PR implements the objective from `#317`: a walkthrough guiding new users through Deepnote setup, covering project exploration, notebook blocks, data sources, and Python environment configuration.
Out of Scope Changes check	✅ Passed	All changes are scoped to adding the walkthrough feature: package.json defines the walkthrough structure and steps, package.nls.json provides localization strings. No extraneous modifications detected.
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.}

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

codecov · 2026-02-17T09:00:22Z

Codecov Report

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

Additional details and impacted files

@@     Coverage Diff     @@
##   main   #321   +/-   ##
===========================
===========================

🚀 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: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@package.nls.json`:
- Around line 298-317: This JSON file failed Prettier formatting; run Prettier
(or your repo's formatter) on package.nls.json and commit the reformatted file
so keys like
"contributes.walkthroughs.deepnoteWelcome.steps.exploreProjects.description" and
other "contributes.walkthroughs.deepnoteWelcome.*" entries are properly
formatted/escaped according to the project's Prettier config; ensure no trailing
commas, correct indentation, and valid JSON syntax before committing.

package.nls.json

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@package.nls.json`:
- Around line 301-305: The walkthrough references a non-existent command
deepnoteExplorer.focus in the package.nls.json key
contributes.walkthroughs.deepnoteWelcome.steps.exploreProjects.description;
update this to a registered command or register the command: either change the
command token to an existing exported/declared command such as
deepnote.refreshExplorer or deepnote.revealInExplorer (ensuring the token
matches an entry in package.json "contributes.commands" and the command
implementation name), or add a new command named deepnoteExplorer.focus to
package.json and implement/exports that command in the extension activation code
so the walkthrough link resolves.

package.nls.json

dinohamzic

Nice improvement, left some suggestions.

dinohamzic · 2026-02-17T10:27:33Z

package.nls.json

+    "contributes.walkthroughs.deepnoteWelcome.description": "Your first steps to set up and explore Deepnote notebooks in VS Code.",
+    "contributes.walkthroughs.deepnoteWelcome.steps.exploreProjects.title": "Explore Your Projects",
+    "contributes.walkthroughs.deepnoteWelcome.steps.exploreProjects.description": {
+        "message": "Open the Deepnote sidebar to browse your projects and notebooks. Create new projects, import existing notebooks, and organize your work.\n[Open Deepnote Explorer](command:deepnoteExplorer.focus)",


This can be simplified to:

Use the Deepnote sidebar to browse, create, import, and organize your projects and notebooks.

dinohamzic · 2026-02-17T10:29:08Z

package.nls.json

+        "comment": ["{Locked='command:deepnoteExplorer.focus'}"]
+    },
+    "contributes.walkthroughs.deepnoteWelcome.steps.exploreProjects.media.altText": "The Deepnote Explorer sidebar showing projects and notebooks",
+    "contributes.walkthroughs.deepnoteWelcome.steps.notebookBlocks.title": "Work with Notebook Blocks",


Should we be more explicit here? It's unclear what "work" really means here.

eg. "Create your first notebook block"

Good point.

dinohamzic · 2026-02-17T10:30:19Z

package.nls.json

+    "contributes.walkthroughs.deepnoteWelcome.steps.connectDataSources.title": "Connect to Your Data Sources",
+    "contributes.walkthroughs.deepnoteWelcome.steps.connectDataSources.description": "Set up integrations to connect your notebooks to databases, data warehouses, and other services. Query your data directly from SQL blocks.",
+    "contributes.walkthroughs.deepnoteWelcome.steps.connectDataSources.media.altText": "The Manage Integrations panel for connecting data sources",
+    "contributes.walkthroughs.deepnoteWelcome.steps.setupEnvironment.title": "Set Up a Python Environment",


Should setting up a python environment be the first thing the user does?

Maybe, but I think it's less important for showing the value of the extension.

feat: Add a walkthrough

8ab3a42

Merge branch 'main' into chris/create-walkthrough

e68abb9

coderabbitai bot requested changes Feb 17, 2026

View reviewed changes

package.nls.json Show resolved Hide resolved

code formating

7753466

coderabbitai bot requested changes Feb 17, 2026

View reviewed changes

package.nls.json Show resolved Hide resolved

Artmann marked this pull request as ready for review February 17, 2026 09:27

Artmann requested a review from a team as a code owner February 17, 2026 09:27

Artmann requested review from dinohamzic, saltenasl and tkislan February 17, 2026 09:27

coderabbitai bot previously approved these changes Feb 17, 2026

View reviewed changes

dinohamzic reviewed Feb 17, 2026

View reviewed changes

update copy

1ccaef2

Artmann dismissed coderabbitai[bot]’s stale review via 1ccaef2 February 17, 2026 10:34

coderabbitai bot approved these changes Feb 17, 2026

View reviewed changes

dinohamzic approved these changes Feb 17, 2026

View reviewed changes

Artmann merged commit 6e4b391 into main Feb 17, 2026
13 checks passed

Artmann deleted the chris/create-walkthrough branch February 17, 2026 10:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add a walkthrough#321

feat: Add a walkthrough#321
Artmann merged 4 commits intomainfrom
chris/create-walkthrough

Artmann commented Feb 17, 2026 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Feb 17, 2026 •

edited

Loading

Walkthrough

❌ Failed checks (1 inconclusive)

Uh oh!

codecov bot commented Feb 17, 2026 •

edited

Loading

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

dinohamzic left a comment

Uh oh!

dinohamzic Feb 17, 2026

Uh oh!

dinohamzic Feb 17, 2026

Uh oh!

Artmann Feb 17, 2026

Uh oh!

dinohamzic Feb 17, 2026

Uh oh!

Artmann Feb 17, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

Artmann commented Feb 17, 2026 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Feb 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

❌ Failed checks (1 inconclusive)

Uh oh!

codecov bot commented Feb 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dinohamzic left a comment

Choose a reason for hiding this comment

Uh oh!

dinohamzic Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

dinohamzic Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

Artmann Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

dinohamzic Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

Artmann Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Artmann commented Feb 17, 2026 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Feb 17, 2026 •

edited

Loading

codecov bot commented Feb 17, 2026 •

edited

Loading