openadapt-maintenance

Automated documentation generator for the OpenAdapt ecosystem. Syncs READMEs, aggregates changelogs, and generates digest pages using LLM.

Lifecycle: Internal. This repository is the publishing infrastructure and source for the public OpenAdapt documentation; it is not an end-user package.

Source of truth: This repository's docs/ tree and mkdocs.yml own docs.openadapt.ai. OpenAdapt/docs, OpenAdapt/mkdocs.yml, and openadapt-gitbook are noncanonical historical trees and must not deploy to the production docs domain. See docs/reference/documentation-governance.md.

Quick Start

# Install dependencies
uv sync

# Sync all READMEs into docs/
python scripts/sync_readmes.py

# Aggregate changelogs
python scripts/aggregate_changelog.py

# Generate What's New (optional: set ANTHROPIC_API_KEY for LLM summary)
python scripts/generate_whats_new.py

# Build and preview the docs site
uv run mkdocs serve

Adding a New Repo

Add an entry to repos.yml — no code changes needed.

Architecture

• Mechanical sync (sync_readmes, aggregate_changelog): deterministic, no API calls
• LLM-enhanced (generate_whats_new, build_architecture): optional, gracefully degrades without API key
• MkDocs Material: builds to static site, deployable on GitHub Pages

Tests

uv sync --extra dev
uv run pytest tests/ -v