docs: update cover image in readme #17
Conversation
📝 WalkthroughWalkthroughThis PR completely restructures the README.md documentation. Content reorganizes from a feature-oriented layout to an installation-first approach. Major changes include: replacing headers with centered HTML and cover image, reorganizing sections (installation, features, architecture, usage, development, Docker, contributing, support), simplifying installation steps with pip commands, introducing an explicit "Architecture" section describing kernel/server bundles, updating CLI usage examples, pivoting from nox/mise/docker testing workflows to Docker-centric development guidance, and consolidating deployment/test automation into three defined Dockerfiles. Possibly related PRs
Pre-merge checks❌ Failed checks (2 warnings)
✅ Passed checks (1 passed)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
📜 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.
⛔ Files ignored due to path filters (1)
assets/deepnote-toolkit-cover-image.pngis excluded by!**/*.png
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
README.md
2-2: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
16-16: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
35-35: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
41-41: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
47-47: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
🔇 Additional comments (1)
README.md (1)
4-4: Asset verified.The cover image exists at
./assets/deepnote-toolkit-cover-image.png. No action needed.
| # Deepnote Toolkit | ||
|
|
||
| #### Option 2: Manual setup | ||
| The Deepnote Toolkit is a Python package that powers the [Deepnote notebook environment](https://github.com/deepnote/deepnote/). It provides the essential functionality that runs in user workspaces, enabling interactive data science workflows with SQL, visualizations, and integrations. |
There was a problem hiding this comment.
Remove trailing whitespace.
Line 16 has trailing whitespace.
-The Deepnote Toolkit is a Python package that powers the [Deepnote notebook environment](https://github.com/deepnote/deepnote/). It provides the essential functionality that runs in user workspaces, enabling interactive data science workflows with SQL, visualizations, and integrations.
+The Deepnote Toolkit is a Python package that powers the [Deepnote notebook environment](https://github.com/deepnote/deepnote/). It provides the essential functionality that runs in user workspaces, enabling interactive data science workflows with SQL, visualizations, and integrations.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| The Deepnote Toolkit is a Python package that powers the [Deepnote notebook environment](https://github.com/deepnote/deepnote/). It provides the essential functionality that runs in user workspaces, enabling interactive data science workflows with SQL, visualizations, and integrations. | |
| The Deepnote Toolkit is a Python package that powers the [Deepnote notebook environment](https://github.com/deepnote/deepnote/). It provides the essential functionality that runs in user workspaces, enabling interactive data science workflows with SQL, visualizations, and integrations. |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
16-16: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
🤖 Prompt for AI Agents
In README.md around line 16, remove the trailing whitespace at the end of that
line; open the file, delete any extra spaces or tabs after the sentence on line
16 (and optionally run a trim-whitespace linter or editor command to remove
trailing whitespace across the file), then save the file.
| ```bash | ||
| $ poetry self add 'poethepoet[poetry_plugin]' | ||
| ``` | ||
| ### Core capabilities |
There was a problem hiding this comment.
Add blank lines before subheadings.
Subheadings require blank lines above them per markdown style (MD022).
## Features
+
### Core capabilities
- **SQL execution engine**: Multi-database SQL support with connection management, query templating via Jinja2, intelligent caching, and query chaining with CTE generation
- **Interactive visualizations**: Vega-Lite charts with VegaFusion optimization, multi-layer support, and interactive selections
- **Data processing**: Enhanced DataFrame utilities, data sanitization, and DuckDB in-memory analytics
- **Jupyter integration**: Custom IPython kernel with scientific computing libraries (pandas, numpy, etc.)
+
### Developer tools
- **CLI interface**: Command-line tools for server management and configuration
- **Streamlit support**: Auto-reload development workflow for Streamlit applications
- **Language server protocol**: Code intelligence and autocompletion support
- **Runtime initialization**: Session persistence, environment variable management, and post-start hooks
+
### Infrastructure
- **Git integration**: SSH/HTTPS authentication for repository access
- **SSH tunneling**: Secure database connections through SSH tunnels
- **Metrics collection**: Prometheus metrics for monitoring and observability
- **Feature flags**: Dynamic feature toggling supportAlso applies to: 41-41, 47-47
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
35-35: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
🤖 Prompt for AI Agents
In README.md around lines 35, 41, and 47, the subheadings lack the required
blank line above them (MD022); fix by inserting a single blank line immediately
before each subheading line so each "###" header is preceded by an empty line,
then run a markdown linter to confirm MD022 passes.
| ## Contributing | ||
|
|
||
| - `builder.Dockerfile`: Creates Python package bundles for different versions (3.9-3.12), generates kernel and server bundles, and packages the toolkit for distribution using Poetry. | ||
| See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup, coding standards, and contribution guidelines. |
There was a problem hiding this comment.
🧩 Analysis chain
Verify referenced documentation files exist.
The README links to CONTRIBUTING.md, LICENSE, and SECURITY.md. Confirm these files are present in the repository.
Also applies to: 167-167, 173-173
🏁 Script executed:
#!/bin/bash
# Verify supporting documentation files
for file in CONTRIBUTING.md LICENSE SECURITY.md; do
if [ -f "$file" ]; then
echo "✓ $file exists"
else
echo "✗ $file missing"
fi
doneLength of output: 63
Create missing CONTRIBUTING.md file.
README.md references CONTRIBUTING.md (line 163), but the file does not exist. Create this file with development setup, coding standards, and contribution guidelines.
🤖 Prompt for AI Agents
In README.md around line 163, the document links to CONTRIBUTING.md which is
missing; create a CONTRIBUTING.md file at the repository root containing the
project's development setup (prerequisites, installation, running locally,
testing), coding standards (style guide, linting, commit message format), and
contribution guidelines (branching model, PR template checklist, review process,
issue reporting and template, and code of conduct), and add a brief note in
README.md if desired pointing to the new file; ensure the CONTRIBUTING.md is
clear, concise, and uses Markdown headings for each section.
Yggdrasill501
deleted the
filipzitny/mar-342-update-cover-images-for-oss-repos
branch
Summary by CodeRabbit