Docs Site

The docs site lives in docs-site/ and is a static Next export for GitHub Pages.

The canonical technical handoff doc is Docs Site. Use this page for the quick developer overview, and use the reference doc for full details on static export behavior, content sources, search, screenshots, custom domains, and GitHub Pages.

Commands

make docs-run    # build and serve static docs locally
make docs-dev    # docs hot reload server
make docs-build  # static docs build
make docs        # isolated demo scans, screenshots, static build

Screenshot policy

make docs uses a separate Docker Compose project named lime-docs, separate PostgreSQL and screenshot volumes, non-default ports, and curated public demo targets. It must never discover or screenshot existing local scans. The partial retry screenshot uses one intentional failed URL in the isolated docs database so the retry card is always visible.

GitHub Pages

The Pages workflow builds committed docs content and committed screenshots. CI does not run live scans because external scans are slower and less deterministic.