docs: update readme and assets

[Yggdrasill501]

Fixes #

Summary by CodeRabbit

• Documentation
  • Reorganized README into a streamlined header/navigation with a consolidated row of external links.
  • Replaced large hero and long feature bullets with a branding-focused heading and concise narrative intro.
  • Introduced a dedicated Requirements subsection and expanded Getting Started with clear steps.
  • Standardized headings, link labels, and formatting across sections.
  • Updated cover image placement/path, refreshed footer attribution, and adjusted spacing/dividers.

[linear]

MAR-350 Fix inconsistencies across the readmes

[coderabbitai]

📝 Walkthrough

Walkthrough

README.md reorganized: cover image moved into a centered assets wrapper and image path updated; MIT license badge removed; header/footer links consolidated into a single row (Website, Docs, Changelog, X, Examples, Community). Hero area simplified for branding and long feature bullets condensed into a concise narrative. Getting started reorganized with a new Requirements subsection and standardized headings/casing. Footer attribution changed to “Built with” (team reference removed). Several developer/documentation subsections were removed or consolidated and minor spacing/divider tweaks applied. No code changes.

Possibly related PRs

• docs: update of the readme #117: Overlapping README edits (cover image/header rewrite, requirements/getting-started restructuring, footer branding updates)

Suggested reviewers

• saltenasl
• jamesbhobbs
• Artmann

Pre-merge checks

❌ 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: update readme and assets" accurately reflects the primary changes in the PR. The raw summary confirms extensive README restructuring, including layout reorganization, section consolidation, and content flow improvements. The branch name "filipzitny/mar-350-fix-inconsistencies-across-the-readmes" suggests the underlying purpose is fixing inconsistencies. The title is specific enough to communicate that documentation was revised and is clearly related to the actual changes made, even though it doesn't capture the specific nature of the updates (consistency fixes and restructuring).

---

📜 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 fdc727d and cff9289.

⛔ Files ignored due to path filters (1)

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

📒 Files selected for processing (1)

• README.md (4 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)

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

README.md (2)

15-28: Documentation reorganization looks good.

The README restructuring—consolidating navigation, adding a Requirements subsection, and reframing features into narrative form—improves clarity and discoverability. Content flows logically from hero to setup to usage to support resources.

Also applies to: 39-42

---

1-13: All referenced files and images exist—no issues found.

Verification confirms all documentation files and assets are present in the repository. The README's internal references are valid.

---

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

[codecov]

Codecov Report

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

Additional details and impacted files

@@          Coverage Diff          @@
##            main    #159   +/-   ##
=====================================
  Coverage     73%     73%           
=====================================
  Files        552     552           
  Lines      44488   44488           
  Branches    5314    5314           
=====================================
  Hits       32708   32708           
  Misses     10017   10017           
  Partials    1763    1763           

🚀 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

📜 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 fe922dc and 151092e.

📒 Files selected for processing (1)

• README.md (5 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)

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

README.md (5)

20-29: Concise feature list with clear formatting.

The condensed feature bullets are well-organized and readable. Consistent formatting across all items.

---

39-42: Clear requirements subsection.

New Requirements section cleanly specifies version constraints for VS Code and Python. Good addition for onboarding clarity.

---

92-101: Improved documentation sections.

Reorganized documentation links with consistent formatting and better structure. Clear entry points for contributors and users seeking deeper context.

---

113-113: Footer branding updated.

Heart emoji and "data driven team" messaging is friendly and inclusive. Aligns with modern documentation tone.

---

3-3: Asset files verified.

Both image files referenced in README.md exist in the assets/ directory:

• assets/deepnote-vscode-cover-image.png ✓
• assets/deepnote-projects.png ✓