update chdb docs #4342
Merged
update chdb docs #4342
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for GitHub.
3 Skipped Deployments
|
|
@auxten @wudidapaopao |
kafka1991
force-pushed
the
victor_chdb_doc
branch
from
c7cd6af to
107f3e4
Compare
Blargian
approved these changes
Aug 29, 2025
There was a problem hiding this comment.
LGTM apart from two small formatting requests:
- Using
Imagecomponent for consistent images in the docs - Using sentence casing for headers for consistency across all pages
docs/chdb/index.md
Outdated
Comment on lines
61
to
63
| <div align="center"> | ||
| <img src="https://github.com/chdb-io/chdb/raw/main/docs/_static/df_bench.png" width="600" alt="DataFrame Benchmark Results" /> | ||
| </div> |
There was a problem hiding this comment.
Hi @kafka1991,
Images can be placed at https://github.com/ClickHouse/clickhouse-docs/tree/main/static/images/chdb/
It's then possible to import in the markdown file:
import Image from '@theme/IdealImage';
import image_name from '@site/static/images/chdb/hyperdx_cloud.png';
You can use the Image component like this:
<Image src={image_name} size="md"/>
See https://github.com/ClickHouse/clickhouse-docs/blob/main/contribute/style-guide.md#images
docs/chdb/install/nodejs.md
Outdated
|
|
||
| ## GitHub repository {#github-repository} | ||
| ### Standalone Queries {#standalone-queries} |
There was a problem hiding this comment.
Suggested change
| ### Standalone Queries {#standalone-queries} | |
| ### Standalone queries {#standalone-queries} |
docs/chdb/install/nodejs.md
Outdated
| ``` | ||
|
|
||
| ## Build from source {#build-from-source} | ||
| ## Error Handling {#error-handling} |
There was a problem hiding this comment.
Suggested change
| ## Error Handling {#error-handling} | |
| ## Error handling {#error-handling} |
docs/chdb/install/nodejs.md
Outdated
| ``` | ||
|
|
||
| ## GitHub Repository {#github-repository} |
There was a problem hiding this comment.
Suggested change
| ## GitHub Repository {#github-repository} | |
| ## GitHub repository {#github-repository} |
docs/chdb/install/python.md
Outdated
| ``` | ||
|
|
||
| Python file example: | ||
| ### Basic Python Usage {#basic-python-usage} |
There was a problem hiding this comment.
Suggested change
| ### Basic Python Usage {#basic-python-usage} | |
| ### Basic Python usage {#basic-python-usage} |
docs/chdb/install/bun.md
Outdated
| ### Query(query, *format) (ephemeral) {#queryquery-format-ephemeral} | ||
| chDB-bun supports two query modes: ephemeral queries for one-time operations and persistent sessions for maintaining database state. | ||
|
|
||
| ### Ephemeral Queries {#ephemeral-queries} |
There was a problem hiding this comment.
Suggested change
| ### Ephemeral Queries {#ephemeral-queries} | |
| ### Ephemeral queries {#ephemeral-queries} |
docs/chdb/install/bun.md
Outdated
|
|
||
| ```bash | ||
| curl -sL https://lib.chdb.io | bash | ||
| ``` | ||
|
|
||
| ## Install {#install} | ||
| #### Install Build Tools {#install-build-tools} |
There was a problem hiding this comment.
Suggested change
| #### Install Build Tools {#install-build-tools} | |
| #### Install build tools {#install-build-tools} |
docs/chdb/install/bun.md
Outdated
| Install [libchdb](https://github.com/chdb-io/chdb): | ||
| ## Installation {#installation} | ||
|
|
||
| ### Step 1: Install System Dependencies {#install-system-dependencies} |
There was a problem hiding this comment.
Suggested change
| ### Step 1: Install System Dependencies {#install-system-dependencies} | |
| ### Step 1: install system dependencies {#install-system-dependencies} |
docs/chdb/index.md
Outdated
| @@ -51,12 +50,25 @@ You can listen to a brief project introduction to chDB, courtesy of Alexey Milov | |||
| <iframe width="560" height="315" src="https://www.youtube.com/embed/cuf_hYn7dqU?si=SzUm7RW4Ae5-YwFo" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe> | |||
| </div> | |||
|
|
|||
| ## Performance Benchmarks {#performance-benchmarks} | |||
There was a problem hiding this comment.
Suggested change
| ## Performance Benchmarks {#performance-benchmarks} | |
| ## Performance benchmarks {#performance-benchmarks} |
docs/chdb/index.md
Outdated
| @@ -11,6 +11,14 @@ keywords: ['chdb', 'embedded', 'clickhouse-lite', 'in-process', 'in process'] | |||
| chDB is a fast in-process SQL OLAP Engine powered by [ClickHouse](https://github.com/clickhouse/clickhouse). | |||
| You can use it when you want to get the power of ClickHouse in a programming language without needing to connect to a ClickHouse server. | |||
|
|
|||
| ## Key Features {#key-features} | |||
There was a problem hiding this comment.
Suggested change
| ## Key Features {#key-features} | |
| ## Key features {#key-features} |
…mprove query examples, and update benchmark results
… across multiple files
kafka1991
force-pushed
the
victor_chdb_doc
branch
from
e083fa0 to
4778809
Compare
Fixed. |
|
@Blargian Thanks for the review! |
|
LGTM |
auxten
approved these changes
Sep 1, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Update docs for chdb
Checklist