README.md

Documentation

This directory contains the source files for the Apache Paimon Rust documentation site, built with MkDocs and the Material for MkDocs theme.

Prerequisites

• Python 3.8+
• pip3

Setup

pip3 install mkdocs-material

Development

Preview the docs locally with live reload:

cd docs
mkdocs serve

Then open http://127.0.0.1:8000 in your browser.

Build

Generate the static site:

cd docs
mkdocs build

The output will be in the docs/site/ directory.

Performance Report

The TPC-DS SF100 performance report is maintained as docs/src/benchmark.md and is included in the MkDocs navigation. Preview it as part of the documentation site:

cd docs
mkdocs serve

Then open http://127.0.0.1:8000/benchmark/.