docs: update readme #18

Yggdrasill501 · 2025-11-02T12:13:24Z

Summary by CodeRabbit

Documentation
- Updated title to “Deepnote Toolkit: SQL, charts, and notebook utilities” with clearer Cloud/Open Source and server startup notes
- Replaced external cover image with a local asset and added a Changelog entry in the top navigation
- Expanded Features: chart blocks (Vega, Altair, Plotly), curated Python libs, preserved SQL reference via docs link
- Renamed Installation/Quickstart to “How to install” and “How to run,” added “Need help?” and simplified footer (removed License/Support)

linear · 2025-11-02T12:13:26Z

MAR-350 Fix inconsistencies across the readmes

coderabbitai · 2025-11-02T12:13:31Z

📝 Walkthrough

Walkthrough

This PR updates only README.md: replaces the external hero image with a local asset, consolidates top navigation and adds a "Changelog" link, rewrites the title/description and Features list (adds chart blocks and clarifies Python kernel libraries), renames Installation/CLI sections and adjusts examples/phrasing, changes Security heading capitalization, adds a "Need help?" section, removes License and Support sections, and simplifies the footer. No code, tests, or public API/export changes.

Sequence Diagram(s)

Possibly related PRs

chore(docs): Clean up readme and contributing guide #14: Overlapping edits to README structure and content (headers, features, installation).
chore(docs): Update cover image #16: Overlap changing the README hero image reference (local vs remote).

Suggested reviewers

OlegWock

Pre-merge checks

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'docs: update readme' is vague and generic. While it accurately indicates that documentation was updated, it fails to convey the specific nature or scope of the changes. The changeset involves substantial updates including title revisions, feature additions, new sections like 'Need help?', removal of sections, and comprehensive restructuring—none of which are reflected in the minimal title.	Consider revising the title to be more descriptive of the main changes, such as 'docs: restructure README with updated features and community section' or another formulation that captures the significant updates to the documentation structure and content.

✅ Passed checks (1 passed)

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

📜 Recent 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 8b29348 and 3029f4c.

📒 Files selected for processing (1)

README.md (3 hunks)

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

GitHub Check: Build and push artifacts for Python 3.11
GitHub Check: Build and push artifacts for Python 3.12
GitHub Check: Build and push artifacts for Python 3.9
GitHub Check: Build and push artifacts for Python 3.10
GitHub Check: Test - Python 3.10
GitHub Check: Test - Python 3.11
GitHub Check: Test - Python 3.9

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

github-actions · 2025-11-02T12:13:53Z

📦 Python package built successfully!

Version: 1.0.0.dev8+11de76a
Wheel: deepnote_toolkit-1.0.0.dev8+11de76a-py3-none-any.whl

Install:

pip install "deepnote-toolkit @ https://deepnote-staging-runtime-artifactory.s3.amazonaws.com/deepnote-toolkit-packages/1.0.0.dev8%2B11de76a/deepnote_toolkit-1.0.0.dev8%2B11de76a-py3-none-any.whl"

README.md

codecov · 2025-11-02T12:15:05Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 76.60%. Comparing base (f5a2f7d) to head (3029f4c).
⚠️ Report is 8 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #18   +/-   ##
=======================================
  Coverage   76.60%   76.60%           
=======================================
  Files          99       99           
  Lines        5476     5476           
  Branches      748      748           
=======================================
  Hits         4195     4195           
  Misses       1281     1281

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

coderabbitai

Actionable comments posted: 1

📜 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 f5a2f7d and cac6a55.

⛔ Files ignored due to path filters (1)

assets/deepnote-toolkit-cover-image.png is excluded by !**/*.png

📒 Files selected for processing (1)

README.md (3 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

README.md

84-84: Files should end with a single newline character

(MD047, single-trailing-newline)

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

GitHub Check: Test - Python 3.11
GitHub Check: Test - Python 3.10
GitHub Check: Test - Python 3.9
GitHub Check: Build and push artifacts for Python 3.12
GitHub Check: Build and push artifacts for Python 3.11
GitHub Check: Build and push artifacts for Python 3.10
GitHub Check: Build and push artifacts for Python 3.9

🔇 Additional comments (3)

README.md (3)

15-16: Documentation updates look good overall.

Product description, features list, section organization, and link updates improve clarity and accuracy. The expanded CLI examples and feature descriptions are helpful.

Also applies to: 20-23, 28-32, 45-62, 73-73, 75-75, 82-82

3-3: Image asset verified.

The hero image file exists at ./assets/deepnote-toolkit-cover-image.png as referenced in README.md line 3.

5-10: No changes needed—navigation bars are intentionally distinct.

Line 5 provides a general nav with "Blog," while line 10 (after badges) includes "Changelog." This dual-nav pattern with different link targets is standard for GitHub READMEs, not a copy-paste error. Remove this review comment.

Likely an incorrect or invalid review comment.

README.md

deepnote-bot · 2025-11-02T12:26:16Z

🚀 Review App Deployment Started

📝 Description	🌐 Link / Info
🌍 Review application	ra-18
🔑 Sign-in URL	Click to sign-in
📊 Application logs	View logs
🔄 Actions	Click to redeploy
🚀 ArgoCD deployment	View deployment
⏰ Last deployed	2025-11-03 11:28:03 (UTC)
📜 Deployed commit	`62552543c69d520114d2d0a0477e750a5ea29797`
🛠️ Toolkit version	`11de76a`

coderabbitai

Actionable comments posted: 1

📜 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 fab8c19 and 77919da.

⛔ Files ignored due to path filters (1)

assets/deepnote-toolkit-cover-image.png is excluded by !**/*.png

📒 Files selected for processing (1)

README.md (3 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

README.md

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

(MD022, blanks-around-headings)

🔇 Additional comments (2)

README.md (2)

79-81: File correctly ends with a trailing newline.

Verification confirms README.md ends with exactly one newline character, meeting markdown linting standard MD047. No further action needed.

3-3: Asset exists—no issue found.

The image file is present at ./assets/deepnote-toolkit-cover-image.png. The reference change is valid.

README.md

coderabbitai

Actionable comments posted: 1

📜 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 77919da and 31e2b80.

⛔ Files ignored due to path filters (1)

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

📒 Files selected for processing (1)

README.md (3 hunks)

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

GitHub Check: Build and push artifacts for Python 3.11
GitHub Check: Build and push artifacts for Python 3.12
GitHub Check: Build and push artifacts for Python 3.9
GitHub Check: Build and push artifacts for Python 3.10
GitHub Check: Test - Python 3.11
GitHub Check: Test - Python 3.9
GitHub Check: Test - Python 3.10

🔇 Additional comments (2)

README.md (2)

62-70: Both markdown linting issues verified as resolved.

✓ Trailing newline present (MD047 resolved)

✓ Blank line before "## Need help?" heading exists (MD022 resolved)

No action required.

3-3: Image asset verified. The file ./assets/deepnote-cover-image.png exists at the expected location.

README.md

Added a new section for Deepnote Toolkit features.

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 31e2b80 and 8b29348.

📒 Files selected for processing (1)

README.md (3 hunks)

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

GitHub Check: Test - Python 3.10
GitHub Check: Test - Python 3.11
GitHub Check: Test - Python 3.9
GitHub Check: Build and push artifacts for Python 3.12
GitHub Check: Build and push artifacts for Python 3.11
GitHub Check: Build and push artifacts for Python 3.10
GitHub Check: Build and push artifacts for Python 3.9

🔇 Additional comments (1)

README.md (1)

1-82: Structure and content updates look solid overall.

The navigation, hero description, features documentation, and new "Need help?" section all improve clarity and user guidance. The local image asset, simplified footer, and refined section headings enhance maintainability and consistency.

README.md

docs: update readme

cac6a55

Yggdrasill501 commented Nov 2, 2025

View reviewed changes

README.md Show resolved Hide resolved

Yggdrasill501 self-assigned this Nov 2, 2025

coderabbitai bot requested changes Nov 2, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

docs: adding newline at the end of file

fab8c19

coderabbitai bot previously approved these changes Nov 2, 2025

View reviewed changes

docs: update readme and logo

77919da

Yggdrasill501 dismissed coderabbitai[bot]’s stale review via 77919da November 2, 2025 18:51

Yggdrasill501 marked this pull request as ready for review November 2, 2025 19:01

Yggdrasill501 requested a review from a team as a code owner November 2, 2025 19:01

docs: update readme

70b2859

coderabbitai bot requested changes Nov 2, 2025

View reviewed changes

README.md Show resolved Hide resolved

docs: update readme

31e2b80

coderabbitai bot requested changes Nov 2, 2025

View reviewed changes

README.md Show resolved Hide resolved

docs: change heading

8b29348

Added a new section for Deepnote Toolkit features.

coderabbitai bot requested changes Nov 3, 2025

View reviewed changes

README.md Show resolved Hide resolved

README.md Show resolved Hide resolved

jamesbhobbs reviewed Nov 3, 2025

View reviewed changes

README.md Show resolved Hide resolved

coderabbitai bot previously approved these changes Nov 3, 2025

View reviewed changes

jamesbhobbs reviewed Nov 3, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

docs: fix grammar

3029f4c

jamesbhobbs dismissed coderabbitai[bot]’s stale review via 3029f4c November 3, 2025 11:21

jamesbhobbs approved these changes Nov 3, 2025

View reviewed changes

coderabbitai bot approved these changes Nov 3, 2025

View reviewed changes

jamesbhobbs merged commit 059d347 into main Nov 3, 2025
31 checks passed

jamesbhobbs deleted the filipzitny/mar-350-fix-inconsistencies-across-the-readmes branch November 3, 2025 11:33

docs: update readme #18

docs: update readme #18

Uh oh!

Conversation

Yggdrasill501 commented Nov 2, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

linear bot commented Nov 2, 2025

Uh oh!

coderabbitai bot commented Nov 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Sequence Diagram(s)

Possibly related PRs

Suggested reviewers

Pre-merge checks

Uh oh!

github-actions bot commented Nov 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Nov 2, 2025 • 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!

deepnote-bot commented Nov 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

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!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Yggdrasill501 commented Nov 2, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Nov 2, 2025 •

edited

Loading

github-actions bot commented Nov 2, 2025 •

edited

Loading

codecov bot commented Nov 2, 2025 •

edited

Loading

deepnote-bot commented Nov 2, 2025 •

edited

Loading