Clickable breadcrumbs

.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/guides/autogen_table_of_contents_guides.py

@@ -0,0 +1,44 @@
+import json
+import os
+
+"""
+This script is used to automatically generate a table of contents from the guide markdown files.
+The table of contents is used in index.md.
+
+It is only necessary to run this script if a new guide .md file has been added to the guides directory.
+"""
+
+
+def extract_title_and_slug(filename):
+    with open(filename, "r") as f:
+        lines = f.readlines()
+
+    title, slug = None, None
+    for line in lines:
+        if line.startswith("title:"):
+            title = line.strip().split(": ")[1]
+        elif line.startswith("slug:"):
+            slug = line.strip().split(": ")[1]
+        if title and slug:
+            return {"title": title, "slug": slug}
+
+    return None
+
+
+def main():
+    json_array = []
+    current_directory = os.getcwd()
+    for filename in os.listdir(current_directory):
+        if filename.endswith(".md") and filename != "index.md":
+            result = extract_title_and_slug(filename)
+            if result:
+                json_array.append(result)
+
+    json_array = sorted(json_array, key=lambda x: x["title"])
+
+    with open("table_of_contents.json", "w") as f:
+        json.dump(json_array, f, indent=4)
+
+
+if __name__ == "__main__":
+    main()

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 → 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/cloud/bestpractices/index.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) |

docs/en/cloud/manage/api/invitations-api-reference.md

@@ -5,5 +5,5 @@ title: Invitations
 
 ## List all invitations
 
-This file is generated by `clickhouseapi.js` during the build process.  If the 
+This file is generated by `clickhouseapi.js` during the build process.  If the
 content needs changing please edit `clickhouseapi.js`.

docs/en/cloud/manage/api/keys-api-reference.md

@@ -5,5 +5,5 @@ title: Keys
 
 ## Get list of all keys
 
-This file is generated by `clickhouseapi.js` during the build process.  If the 
-content needs changing please edit `clickhouseapi.js`.
+This file is generated by `clickhouseapi.js` during the build process.  If the
+content needs changing please edit `clickhouseapi.js`.

docs/en/cloud/manage/api/members-api-reference.md

@@ -5,5 +5,5 @@ title: Members
 
 ## List organization members
 
-This file is generated by `clickhouseapi.js` during the build process.  If the 
+This file is generated by `clickhouseapi.js` during the build process.  If the
 content needs changing please edit `clickhouseapi.js`.

docs/en/cloud/manage/api/organizations-api-reference.md

@@ -5,5 +5,5 @@ title: Organizations
 
 ## Get organization details
 
-This file is generated by `clickhouseapi.js` during the build process.  If the 
+This file is generated by `clickhouseapi.js` during the build process.  If the
 content needs changing please edit `clickhouseapi.js`.

docs/en/cloud/manage/api/services-api-reference.md

@@ -5,5 +5,5 @@ title: Services
 
 ## List of organization services
 
-This file is generated by `clickhouseapi.js` during the build process.  If the 
-content needs changing please edit `clickhouseapi.js`.
+This file is generated by `clickhouseapi.js` during the build process.  If the
+content needs changing please edit `clickhouseapi.js`.

docs/en/cloud/manage/index.md

@@ -0,0 +1,27 @@
+---
+slug: /en/cloud/manage
+keywords: [AWS, Cloud, serverless, management]
+title: Overview
+hide_title: true
+---
+
+# Managing Cloud 
+
+In this section of the docs you will find all the information you may need about managing ClickHouse cloud. This section contains the following pages:
+
+| Page                                                                  | Description                                                                                                                                    |
+|-----------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|
+| [Service Types](/docs/en/cloud/manage/service-types)                  | Describes the different service options, their features, and considerations for choosing the right one.                                        |
+| [Integrations](/docs/en/manage/integrations)                          | Covers ClickHouse Cloud's built-in integrations, custom integrations, and integrations that are not supported.                                 |
+| [Backups](/docs/en/cloud/manage/backups)                              | Describes how backups work in ClickHouse Cloud, what options you have to configure backups for your service, and how to restore from a backup. |
+| [Monitoring](/docs/en/integrations/prometheus)                        | How to integrate Prometheus as a way to monitor ClickHouse cloud.                                                                              |
+| [Billing](/docs/en/manage/billing)                                    | Explains the pricing model for ClickHouse Cloud, including the factors that affect the cost of your service.                                   |
+| [Configuring Settings](/docs/en/manage/settings)                      | Describes how to configure settings for ClickHouse Cloud.                                                                                      |
+| [Replica-aware Routing](/docs/en/manage/replica-aware-routing)        | Explains what Replica-aware Routing in ClickHouse Cloud is, its limitations, and how to configure it.                                          |
+| [Automatic Scaling](/docs/en/manage/scaling)                          | Explains how ClickHouse Cloud services can be scaled manually or automatically based on your resource needs.                                   |
+| [Service Uptime and SLA](/docs/en/cloud/manage/service-uptime)        | Information about service uptimes and Service Level Agreements offered for production instances.                                               |
+| [Notifications](/docs/en/cloud/notifications)                         | Shows how ClickHouse Cloud notifications are received and how they can be customized.                                                          |
+| [Upgrades](/docs/en/manage/updates)                                   | Information on how upgrades are rolled out in ClickHouse Cloud.                                                                                |
+| [Delete Account](/docs/en/cloud/manage/close_account)                 | Information on how to close or delete your account when necessary.                                                                             |
+| [Programmatic API Access with Postman](/docs/en/cloud/manage/postman) | A guide to help you test the ClickHouse API using Postman.                                                                                     |
+| [Troubleshooting](/docs/en/faq/troubleshooting)                       | A collection of commonly encountered issues and how to troubleshoot them.                                                                      |

docs/en/cloud/reference/index.md

@@ -0,0 +1,20 @@
+---
+slug: /en/cloud/reference
+keywords: [Cloud, reference, architecture, SharedMergeTree, Compute-Compute Separation, Bring Your Own Cloud, Changelogs, Supported Cloud Regions, Cloud Compatibility]
+title: Overview
+hide_title: true
+---
+
+# Cloud Reference
+
+This section acts as a reference guide for some of the more technical details of ClickHouse Cloud and contains the following pages:
+
+| Page                                                                  | Description                                                                                               |
+|-----------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------|
+| [Architecture](/docs/en/cloud/reference/architecture)                 | Discusses the architecture of ClickHouse Cloud, including storage, compute, administration, and security. |
+| [SharedMergeTree](/docs/en/cloud/reference/shared-merge-tree)         | Explainer on SharedMergeTree, the cloud-native replacement for the ReplicatedMergeTree and analogues.     |
+| [Warehouses](/docs/en/cloud/reference/compute-compute-separation)     | Explainer on what Warehouses and Compute-Compute separation are in ClickHouse Cloud.                      |
+| [BYOC (Bring Your Own Cloud)](/docs/en/cloud/reference/byoc)          | Explainer on the Bring Your Own Cloud (BYOC) service available with ClickHouse Cloud.                     |
+| [Changelogs](/docs/en/whats-new/cloud)                                | Cloud ChangeLogs and Release Notes.                                                                       |
+| [Cloud Compatibility](/docs/en/whats-new/cloud-compatibility)         | A guide to what to expect functionally and operationally in ClickHouse Cloud.                             |
+| [Supported Cloud Regions](/docs/en/cloud/reference/supported-regions) | A list of the supported cloud regions for AWS, Google and Azure.                                          |

docs/en/cloud/security/connectivity-overview.md

@@ -0,0 +1,15 @@
+---
+slug: /en/cloud/security/connectivity
+title: connectivity overview
+---
+
+# Connectivity
+
+This section looks at connectivity and contains the following pages:
+
+| Page                                                                 | Description                                                                                                                   |
+|----------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|
+| [Setting IP Filters](/docs/en/cloud/security/setting-ip-filters)     | A guide on how to control traffic to your ClickHouse services using IP access lists.                                          |
+| [Private Networking](/docs/en/cloud/security/private-link-overview)  | Information on how to connect your services to your cloud virtual network.                                                    |
+| [Accessing S3 Data Securely](/docs/en/cloud/security/secure-s3)      | A guide on how to leverage role-based access to authenticate with Amazon Simple Storage Service(S3) and access data securely. |
+| [Cloud IP Addresses](/docs/en/manage/security/cloud-endpoints-api)   | Tables listing the static IPs and S3 endpoints for each supported cloud and region in ClickHouse Cloud.                       |

docs/en/cloud/security/index.md

@@ -0,0 +1,19 @@
+---
+slug: /en/cloud/security
+keywords: [Cloud, Security]
+title: Overview
+hide_title: true
+---
+
+# ClickHouse Cloud Security
+
+This section delves into security in ClickHouse Cloud and contains the following pages:
+
+| Page                                                                         | Description                                                                                                               |
+|------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|
+| [Shared Responsibility Model](en/cloud/security/shared-responsibility-model) | Information on the security features offered for each service type.                                                       |
+| [Cloud Access Management](.)                                                 | Information on access control, authentication, SSO setup, common access management queries and how to invite new users.   |
+| [Connectivity](.)                                                            | Information on setting IP filters, private networking, secure access of S3 data and Cloud IP addresses.                   |
+| [Customer Managed Encryption Keys](.)                                        | Information about how customers can leverage their own Key Management Service (KMS) key.                                  |
+| [Audit Logging](en/cloud/security/audit-logging)                             | A guide to audit logging in ClickHouse Cloud.                                                                             |
+| [Privacy and Compliance](.)                                                  | Information on security and compliance of CLickHouse Cloud, a guide on how to view and correct your personal information. |

docs/en/cloud/security/privacy-compliance-overview.md

@@ -0,0 +1,14 @@
+---
+sidebar_label: Privacy and Compliance Overview
+slug: /en/cloud/security/privacy-compliance-overview
+title: Privacy Compliance Overview
+---
+
+# Privacy and Compliance
+
+This section contains the following pages:
+
+| Page                                                                       | Description                                                  |
+|----------------------------------------------------------------------------|--------------------------------------------------------------|
+| [Security and Compliance](/docs/en/cloud/security/security-and-compliance) | Security reports and privacy compliance of ClickHouse Cloud. |
+| [Personal Data Access](/docs/en/cloud/security/personal-data-access)       | Information on how to access your personal data.             |

docs/en/cloud/security/private-link-overview.md

@@ -4,7 +4,7 @@ slug: /en/cloud/security/private-link-overview
 title: Private Link Overview
 ---
 
-# Private Link Overview
+# Private Networking Overview
 
 ClickHouse Cloud provides the ability to connect your services to your cloud virtual network. Refer to the guides below for your provider: