Merge pull request #2779 from Blargian/menu-improvement

Clickable breadcrumbs

Author: gingerwizard

.gitignore

@@ -40,4 +40,10 @@ FormatFactorySettingsDeclaration.h
 FormatFactorySettings.h
 Settings.cpp
 
+# Files whose content gets autogenerated
+docs/en/cloud/manage/api/invitations-api-reference.md
+docs/en/cloud/manage/api/keys-api-reference.md
+docs/en/cloud/manage/api/members-api-reference.md
+docs/en/cloud/manage/api/organizations-api-reference.md
+docs/en/cloud/manage/api/services-api-reference.md
 .vscode

docs/en/chdb/getting-started.md

@@ -147,7 +147,7 @@ This is fine to do with variables defined in your program, but don't do it with
 ## Configuring the output format
 
 The default output format is `CSV`, but we can change that via the `output_format` parameter. 
-chDB supports the ClickHouse data formats, as well as [some of its own](data-formats.md), including `DataFrame`, which returns a Pandas DataFrame:
+chDB supports the ClickHouse data formats, as well as [some of its own](/docs/en/chdb/reference/data-formats.md), including `DataFrame`, which returns a Pandas DataFrame:
 
 ```python
 result = chdb.query(

docs/en/chdb/guides/index.md

@@ -0,0 +1,13 @@
+---
+title: chDB Guides
+slug: /en/chdb/guides
+description: Index page for chDB guides
+keywords: [chdb, guides]
+---
+
+import TableOfContentsJSON from './table_of_contents.json'
+import { TableOfContents } from '/src/components/TableOfContents'
+
+Take a look at our chDB developer guides below:
+
+<TableOfContents items={TableOfContentsJSON} />

docs/en/chdb/guides/table_of_contents.json

@@ -0,0 +1,30 @@
+[
+    {
+        "title": "How to query Apache Arrow with chDB",
+        "slug": "/en/chdb/guides/apache-arrow"
+    },
+    {
+        "title": "How to query Pandas DataFrames with chDB",
+        "slug": "/en/chdb/guides/pandas"
+    },
+    {
+        "title": "How to query Parquet files",
+        "slug": "/en/chdb/guides/querying-parquet"
+    },
+    {
+        "title": "How to query a remote ClickHouse server",
+        "slug": "/en/chdb/guides/query-remote-clickhouse"
+    },
+    {
+        "title": "How to query data in an S3 bucket",
+        "slug": "/en/chdb/guides/querying-s3"
+    },
+    {
+        "title": "JupySQL and chDB",
+        "slug": "/en/chdb/guides/jupysql"
+    },
+    {
+        "title": "Using a clickhouse-local database",
+        "slug": "/en/chdb/guides/clickhouse-local"
+    }
+]

docs/en/chdb/install/index.md

@@ -0,0 +1,17 @@
+---
+title: Language Integrations Index
+slug: /en/chdb/install
+description: Index page for chDB language integrations
+keywords: [python, NodeJS, Go, Rust, Bun, C, C++]
+---
+
+Instructions for how to get setup with chDB are available below for the following languages and runtimes:
+
+| Language                               |
+|----------------------------------------|
+| [Python](/docs/en/chdb/install/python) |
+| [NodeJS](/docs/en/chdb/install/nodejs) |
+| [Go](/docs/en/chdb/install/go)         |
+| [Rust](/docs/en/chdb/install/rust)     |
+| [Bun](/docs/en/chdb/install/bun)       |
+| [C and C++](/docs/en/chdb/install/c)   |

docs/en/chdb/data-formats.md renamed to docs/en/chdb/reference/data-formats.md

@@ -1,7 +1,7 @@
 ---
 title: Data Formats
 sidebar_label: Data Formats
-slug: /en/chdb/data-formats
+slug: /en/chdb/reference/data-formats
 description: Data Formats for chDB
 keywords: [chdb, data formats]
 ---

docs/en/chdb/reference/index.md

@@ -0,0 +1,11 @@
+---
+title: chDB Technical Reference
+slug: /en/chdb/reference
+description: Data Formats for chDB
+keywords: [chdb, data formats]
+---
+
+| Reference page       |
+|----------------------|
+| [Data Formats](/en/chdb/reference/data-formats)  |
+| [SQL Reference](/en/chdb/reference/sql-reference) |

docs/en/chdb/reference/sql-reference.md

@@ -0,0 +1,22 @@
+---
+title: SQL Reference
+sidebar_label: SQL Reference
+slug: /en/chdb/reference/sql-reference
+description: SQL Reference for chDB
+keywords: [chdb, sql reference]
+---
+
+chdb supports the same SQL syntax, statements, engines and functions as ClickHouse:
+
+| Topic                      |
+|----------------------------|
+| [SQL Syntax](/docs/en/sql-reference/syntax)          |
+| [Statements](/docs/en/sql-reference/statements)          |
+| [Table Engines](/docs/en/engines/table-engines)       |
+| [Database Engines](/docs/en/engines/database-engines)    |
+| [Regular Functions](/docs/en/sql-reference/functions)   |
+| [Aggregate Functions](/docs/en/sql-reference/aggregate-functions) |
+| [Table Functions](/docs/en/sql-reference/table-functions)     | 
+| [Window Functions](/docs/en/sql-reference/window-functions)    |
+
+For further information and examples, see the [ClickHouse SQL Reference](/docs/en/sql-reference).

docs/en/chdb/sql-reference.md

@@ -0,0 +1,19 @@
+---
+slug: /en/cloud/bestpractices
+keywords: [Cloud, Best Practices, Bulk Inserts, Asynchronous Inserts, Avoid Mutations, Avoid Nullable Columns, Avoid Optimize Final, Low Cardinality Partitioning Key]
+title: Overview
+hide_title: true
+---
+
+# Best Practices in ClickHouse
+
+This section provides six best practices you will want to follow to get the most out of ClickHouse Cloud.
+
+| Best Practice                                                                                              |
+|------------------------------------------------------------------------------------------------------------|
+| [Use Bulk Inserts](/docs/en/cloud/bestpractices/bulk-inserts)                                              |
+| [Asynchronous Inserts](/docs/en/cloud/bestpractices/asynchronous-inserts)                                  |
+| [Avoid Mutations](/docs/en/cloud/bestpractices/avoid-mutations)                                            |
+| [Avoid Nullable Columns](/docs/en/cloud/bestpractices/avoid-nullable-columns)                              |
+| [Avoid Optimize Final](/docs/en/cloud/bestpractices/avoid-optimize-final)                                  |
+| [Choose a Low Cardinality Partitioning Key](/docs/en/cloud/bestpractices/low-cardinality-partitioning-key) |