alibaba · lucasfang · Dec 16, 2025 · Dec 16, 2025 · Dec 16, 2025
diff --git a/.github/workflows/build_docs.yaml b/.github/workflows/build_docs.yaml
@@ -48,7 +48,7 @@ jobs:
         run: |
           sudo apt-get update
           sudo apt-get install -y doxygen
-          make install-deps
+          pip install -r docs/requirements.txt
 
       - name: Build API
         run: |
@@ -63,6 +63,7 @@ jobs:
             mkdir -p /tmp/site
             cp -r ./_build/html/* /tmp/site/
             cd -
+            touch .nojekyll
 
       - name: Deploy to gh-pages
         if: github.event_name == 'push' && github.ref == 'refs/heads/main'

diff --git a/docs/source/implementations/api.rst → docs/source/api.rst b/docs/source/implementations/api.rst → docs/source/api.rst
diff --git a/docs/source/implementations/api/catalog.rst → docs/source/api/catalog.rst b/docs/source/implementations/api/catalog.rst → docs/source/api/catalog.rst
diff --git a/docs/source/implementations/api/clean.rst → docs/source/api/clean.rst b/docs/source/implementations/api/clean.rst → docs/source/api/clean.rst
diff --git a/docs/source/implementations/api/commit.rst → docs/source/api/commit.rst b/docs/source/implementations/api/commit.rst → docs/source/api/commit.rst
diff --git a/...source/implementations/api/data_types.rst → docs/source/api/data_types.rst b/...source/implementations/api/data_types.rst → docs/source/api/data_types.rst
diff --git a/docs/source/implementations/api/defs.rst → docs/source/api/defs.rst b/docs/source/implementations/api/defs.rst → docs/source/api/defs.rst
diff --git a/docs/source/implementations/api/executor.rst → docs/source/api/executor.rst b/docs/source/implementations/api/executor.rst → docs/source/api/executor.rst
diff --git a/...ource/implementations/api/file_format.rst → docs/source/api/file_format.rst b/...ource/implementations/api/file_format.rst → docs/source/api/file_format.rst
diff --git a/...source/implementations/api/file_index.rst → docs/source/api/file_index.rst b/...source/implementations/api/file_index.rst → docs/source/api/file_index.rst
diff --git a/...ource/implementations/api/file_system.rst → docs/source/api/file_system.rst b/...ource/implementations/api/file_system.rst → docs/source/api/file_system.rst
diff --git a/...urce/implementations/api/global_index.rst → docs/source/api/global_index.rst b/...urce/implementations/api/global_index.rst → docs/source/api/global_index.rst
diff --git a/docs/source/implementations/api/io.rst → docs/source/api/io.rst b/docs/source/implementations/api/io.rst → docs/source/api/io.rst
diff --git a/docs/source/implementations/api/memory.rst → docs/source/api/memory.rst b/docs/source/implementations/api/memory.rst → docs/source/api/memory.rst
diff --git a/.../source/implementations/api/predicate.rst → docs/source/api/predicate.rst b/.../source/implementations/api/predicate.rst → docs/source/api/predicate.rst
diff --git a/docs/source/implementations/api/read.rst → docs/source/api/read.rst b/docs/source/implementations/api/read.rst → docs/source/api/read.rst
diff --git a/docs/source/implementations/api/scan.rst → docs/source/api/scan.rst b/docs/source/implementations/api/scan.rst → docs/source/api/scan.rst
diff --git a/docs/source/implementations/api/write.rst → docs/source/api/write.rst b/docs/source/implementations/api/write.rst → docs/source/api/write.rst
diff --git a/...source/implementations/basic_concepts.rst → docs/source/basic_concepts.rst b/...source/implementations/basic_concepts.rst → docs/source/basic_concepts.rst
@@ -19,16 +19,16 @@
 .. https://github.com/apache/paimon/blob/master/docs/content/concepts/basic-concepts.md
 
 Basic Concepts
-=========================
+========================
 
 File Layouts
--------------------------
+------------------------
 All files of a table are stored under one base directory. Paimon files are
 organized in a layered style. The following image illustrates the file layout.
 Starting from a snapshot file, Paimon readers can recursively access all records
 from the table.
 
-.. image:: ../_static/file-layout.png
+.. image:: _static/file-layout.png
    :alt: File Layout
    :align: center
    :width: 100%

diff --git a/docs/source/implementations/build_system.rst → docs/source/build_system.rst b/docs/source/implementations/build_system.rst → docs/source/build_system.rst
diff --git a/docs/source/implementations/building.rst → docs/source/building.rst b/docs/source/implementations/building.rst → docs/source/building.rst
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -111,7 +111,7 @@
 }
 
 # The master toctree document.
-master_doc = "implementations/index"
+master_doc = "index"
 
 version = "0.9.0"
 

diff --git a/...source/implementations/documentations.rst → docs/source/documentations.rst b/...source/implementations/documentations.rst → docs/source/documentations.rst
diff --git a/...source/implementations/examples/clean.rst → docs/source/examples/clean.rst b/...source/implementations/examples/clean.rst → docs/source/examples/clean.rst
diff --git a/...source/implementations/examples/index.rst → docs/source/examples/index.rst b/...source/implementations/examples/index.rst → docs/source/examples/index.rst
diff --git a/...tions/examples/write_commit_scan_read.rst → ...ource/examples/write_commit_scan_read.rst b/...tions/examples/write_commit_scan_read.rst → ...ource/examples/write_commit_scan_read.rst
diff --git a/...ource/implementations/getting_started.rst → docs/source/getting_started.rst b/...ource/implementations/getting_started.rst → docs/source/getting_started.rst
@@ -23,8 +23,8 @@ understanding of C++ Paimon. These articles will get you set up quickly with C++
 Paimon and give you a taste of what the library is capable of.
 
 Start here to gain a basic understanding of Paimon, and move on to the
-:doc:`/implementations/user_guide` to explore more specific topics and
-underlying concepts, or the :doc:`/implementations/api` to explore Paimon's API.
+:doc:`/user_guide` to explore more specific topics and
+underlying concepts, or the :doc:`/api` to explore Paimon's API.
 
 .. toctree::
 

diff --git a/docs/source/implementations/index.rst b/docs/source/implementations/index.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -12,13 +12,94 @@
 .. See the License for the specific language governing permissions and
 .. limitations under the License.
 
-:html_theme.sidebar_secondary.remove:
+.. _implementations:
+
+C++ Paimon Documentation
+========================
+
+Paimon C++ is a high-performance C++ implementation of Apache Paimon. We aim to
+provide a native, high-performance and extensible implementation that allows
+native engines to access the Paimon datalake format with maximum efficiency.
+
+.. grid:: 1 2 2 2
+   :gutter: 4
+   :padding: 2 2 0 0
+   :class-container: sd-text-center
+
+   .. grid-item-card:: Getting started
+      :class-card: contrib-card
+      :shadow: none
+
+      Start here to gain a basic understanding of Paimon with
+      an installation and linking guide, basic concepts etc.
+
+      +++
+
+      .. button-link:: getting_started.html
+         :click-parent:
+         :color: primary
+         :expand:
+
+         To Getting started
+
+   .. grid-item-card:: User Guide
+      :class-card: contrib-card
+      :shadow: none
+
+      Explore more specific topics and underlying concepts
+      of Paimon C++
+
+      +++
+
+      .. button-link:: user_guide.html
+         :click-parent:
+         :color: primary
+         :expand:
+
+         To the User Guide
+
+.. grid:: 1 2 2 2
+   :gutter: 4
+   :padding: 2 2 0 0
+   :class-container: sd-text-center
+
+   .. grid-item-card:: Examples
+      :class-card: contrib-card
+      :shadow: none
+
+      Find the description and location of the examples
+      using Paimon C++ library
+
+      +++
+
+      .. button-link:: examples/index.html
+         :click-parent:
+         :color: primary
+         :expand:
+
+         To the Examples
+
+   .. grid-item-card:: API Reference
+      :class-card: contrib-card
+      :shadow: none
+
+      Explore Paimon‘s API reference documentation
+
+      +++
+
+      .. button-link:: api.html
+         :click-parent:
+         :color: primary
+         :expand:
+
+         To the API Reference
 
-C++ Paimon
-============
 
 .. toctree::
    :maxdepth: 2
    :hidden:
 
-   implementations/index
+   getting_started
+   user_guide
+   Examples <examples/index>
+   api
diff --git a/docs/source/implementations/user_guide.rst → docs/source/user_guide.rst b/docs/source/implementations/user_guide.rst → docs/source/user_guide.rst
diff --git a/...ntations/user_guide/append_only_table.rst → docs/source/user_guide/append_only_table.rst b/...ntations/user_guide/append_only_table.rst → docs/source/user_guide/append_only_table.rst
diff --git a/...urce/implementations/user_guide/arrow.rst → docs/source/user_guide/arrow.rst b/...urce/implementations/user_guide/arrow.rst → docs/source/user_guide/arrow.rst
diff --git a/...ce/implementations/user_guide/catalog.rst → docs/source/user_guide/catalog.rst b/...ce/implementations/user_guide/catalog.rst → docs/source/user_guide/catalog.rst
diff --git a/...urce/implementations/user_guide/clean.rst → docs/source/user_guide/clean.rst b/...urce/implementations/user_guide/clean.rst → docs/source/user_guide/clean.rst
diff --git a/...rce/implementations/user_guide/commit.rst → docs/source/user_guide/commit.rst b/...rce/implementations/user_guide/commit.rst → docs/source/user_guide/commit.rst
diff --git a/...implementations/user_guide/data_types.rst → docs/source/user_guide/data_types.rst b/...implementations/user_guide/data_types.rst → docs/source/user_guide/data_types.rst
diff --git a/...e/implementations/user_guide/manifest.rst → docs/source/user_guide/manifest.rst b/...e/implementations/user_guide/manifest.rst → docs/source/user_guide/manifest.rst
diff --git a/...e/implementations/user_guide/prefetch.rst → docs/source/user_guide/prefetch.rst b/...e/implementations/user_guide/prefetch.rst → docs/source/user_guide/prefetch.rst
@@ -15,7 +15,7 @@
 Prefetch
 ========
 
-.. image:: ../../_static/prefetch.svg
+.. image:: ../_static/prefetch.svg
    :alt: File Layout
    :align: center
    :width: 100%

diff --git a/...ntations/user_guide/primary_key_table.rst → docs/source/user_guide/primary_key_table.rst b/...ntations/user_guide/primary_key_table.rst → docs/source/user_guide/primary_key_table.rst
@@ -67,7 +67,7 @@ or multiple data files and each data file belongs to exactly one sorted run.
 Records within a data file are sorted by their primary keys. Within a sorted run,
 ranges of primary keys of data files never overlap.
 
-.. image:: ../../_static/sorted-runs.png
+.. image:: ../_static/sorted-runs.png
    :alt: Sorted Runs
    :align: center
    :width: 100%

diff --git a/...ource/implementations/user_guide/read.rst → docs/source/user_guide/read.rst b/...ource/implementations/user_guide/read.rst → docs/source/user_guide/read.rst
diff --git a/...rce/implementations/user_guide/schema.rst → docs/source/user_guide/schema.rst b/...rce/implementations/user_guide/schema.rst → docs/source/user_guide/schema.rst
diff --git a/...e/implementations/user_guide/snapshot.rst → docs/source/user_guide/snapshot.rst b/...e/implementations/user_guide/snapshot.rst → docs/source/user_guide/snapshot.rst
diff --git a/...urce/implementations/user_guide/write.rst → docs/source/user_guide/write.rst b/...urce/implementations/user_guide/write.rst → docs/source/user_guide/write.rst