README.md

Documentation

This documentation follows the Diataxis model so readers can choose the right level of detail quickly.

flowchart TD
    T["Tutorials"] --> T1["Getting Started"]
    H["How-to Guides"] --> H1["Install"]
    H --> H2["Install And Use In PostgreSQL"]
    H --> H3["Run Benchmarks"]
    R["Reference"] --> R1["SQL API"]
    R --> R2["Index Options"]
    R --> R3["Benchmark Output"]
    E["Explanation"] --> E1["Architecture"]
    E --> E2["Benchmark Results"]
    E --> E3["ADRs"]

Loading

Tutorials

• Getting started

How-to guides

• Install the extension
• Install and use it in PostgreSQL
• Run the benchmark suite

Reference

• SQL API
• Index options
• Benchmark output schema
• Compatibility and upgrade policy

Explanation

• Architecture
• Benchmark results
• ADRs