Improve Documentation (#72)

* Add getting started entries

* Script to generate cli and configuration reference

* Separate merge and split pdf tutorial

* Add frontmatter to every page

---------

Co-authored-by: avvertix <5672748+avvertix@users.noreply.github.com>

Author: avvertix

.github/workflows/update-docs.yml

@@ -0,0 +1,38 @@
+name: Update reference docs
+
+on:
+  pull_request:
+    paths:
+      - "src/parxy_cli/commands/**"
+      - "src/parxy_cli/cli.py"
+      - "src/parxy_core/models/config.py"
+      - "scripts/generate_docs.py"
+
+jobs:
+  update-docs:
+    name: Regenerate reference docs
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 1
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7.3.1
+        with:
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Generate reference docs
+        run: uv run python scripts/generate_docs.py
+
+      - name: Commit if changed
+        uses: stefanzweifel/git-auto-commit-action@v7.1.0
+        with:
+          commit_message: "docs: sync CLI and configuration reference"
+          file_pattern: "docs/reference/*.md"

docs/howto/add_new_parser.md

@@ -1,3 +1,8 @@
+---
+title: Add a new parser
+description: How to implement a custom driver, register it with Parxy at runtime, and make it available alongside the built-in parsers.
+---
+
 # How to Add a New Parser to Parxy
 
 Parxy is designed to be **extensible** — you can integrate new parsing backends (drivers) or create custom variants of existing ones directly from your Python code, without modifying the core library.

docs/howto/batch_processing.md

@@ -1,3 +1,8 @@
+---
+title: Process multiple documents in parallel
+description: How to use Parxy's batch API to parse many documents concurrently, control worker count, handle per-file errors, and collect structured results.
+---
+
 # How to Process Multiple Documents in Parallel
 
 Parxy provides a `batch` method for processing multiple documents in parallel, with support for per-file configuration. This is useful when you need to parse many documents efficiently or when different documents require different parsing strategies.

docs/howto/configure_landingai.md

@@ -1,3 +1,8 @@
+---
+title: Configure LandingAI ADE
+description: How to set up the LandingAI Agentic Document Extraction driver, configure the API key and environment, and override parsing options per document.
+---
+
 # How to Configure LandingAI ADE
 
 This guide shows you how to configure the LandingAI ADE (Agentic Document Extraction) driver for document processing, including setting default options and overriding them on a per-document basis.

docs/howto/configure_llamaparse.md

@@ -1,3 +1,8 @@
+---
+title: Configure LlamaParse
+description: How to set up the LlamaParse driver, configure the API key and parsing mode, and override options on a per-document basis for better extraction results.
+---
+
 # How to Configure LlamaParse
 
 This guide shows you how to configure the LlamaParse driver for document processing, including setting default options and overriding them on a per-document basis.

docs/howto/configure_llmwhisperer.md

@@ -1,3 +1,8 @@
+---
+title: Configure LLMWhisperer
+description: How to set up the LLMWhisperer driver, configure the API key and parsing mode, and override options on a per-document basis for better extraction results.
+---
+
 # How to Configure LLMWhisperer
 
 This guide shows you how to configure the LLMWhisperer driver for document processing, including setting default options and overriding them on a per-document basis.

docs/howto/configure_observability.md

@@ -1,3 +1,8 @@
+---
+title: Configure observability
+description: How to enable OpenTelemetry tracing and metrics in Parxy, connect to an OTLP collector, and monitor document processing operations in your observability stack.
+---
+
 # How to Configure Observability
 
 This guide shows you how to enable and configure OpenTelemetry-based observability in Parxy to monitor document processing operations.

docs/howto/configure_pdfact.md

@@ -1,3 +1,8 @@
+---
+title: Configure PdfAct
+description: How to set up the PdfAct driver against a self-hosted or remote service instance, configure the base URL and API key, and run PdfAct locally with Docker.
+---
+
 # How to Configure PdfAct
 
 This guide shows you how to configure the PdfAct driver for document processing using a self-hosted or remote PdfAct service.

docs/howto/configure_pymupdf.md

@@ -1,3 +1,8 @@
+---
+title: Configure PyMuPDF
+description: How to use Parxy's default PyMuPDF driver, choose the right extraction level for your use case, and adjust the output when working with local PDF files.
+---
+
 # How to Configure PyMuPDF
 
 This guide shows you how to use the PyMuPDF driver for document processing. PyMuPDF is the default driver in Parxy and requires no external services or API keys.

docs/howto/configure_unstructured_local.md

@@ -1,3 +1,8 @@
+---
+title: Configure Unstructured library
+description: How to install and configure the Unstructured local driver for offline PDF parsing without external APIs, including extraction levels and output options.
+---
+
 # How to Configure Unstructured Local
 
 This guide shows you how to configure the Unstructured Local driver for document processing. This driver uses the open-source `unstructured` library for local document parsing without requiring external services.