Documentation index

Public docs are generated from selected source files

The build publishes an allowlist of repository docs, records source metadata, and checks internal links in the generated static output. Private agent procedure content is not published by the site package.

Published

Current Guides

Partial

Repository README

Project orientation, workspace map, first build, and local demo entry point.

open source

Current

Documentation index

Documentation map, source-of-truth rules, and planned guide boundaries.

open source

Current

Quickstart

Verified local demo path from checkout to queryable heartbeat data.

open source

Current

Installation

Manual source-build binary install layout and current unsupported package formats.

open source

Current

Docker and containers

Operator-owned container build/run recipe, volumes, ports, token/TLS mounts, and MinIO/S3 wiring.

open source

Current

Current limitations

Explicit and implicit implementation limits by component.

open source

Published

Reference Material

Reference

Design reference

Target architecture and rationale for the Lightmetrics system.

open source

Partial

Active-active S3 ingest

S3-manifest ingest direction and active-active conditional-create constraints.

open source

Reference

Design artifact ledger

Links and notes for console and public website design artifacts.

open source

Reference

Public site design task

Claude Design prompt and intake workflow for public website mockups.

open source

Planned

Not Published As Complete

Path	Plan	Scope
`docs/user-guide.md`	DOC-02E	Supported console, Grafana, query, logs, alerts, dashboards, and disabled workflows.
`docs/admin-guide.md`	DOC-02F	Topology, auth, TLS, sizing, object-store modes, reconciliation, retention, and recovery caveats.
`docs/configuration.md`	DOC-02G	Every server and agent TOML field, validation rule, default/sample value, secret-file behavior, and cross-component limit coupling.
`docs/api.md`	DOC-02H	Ingest, query, logs, alerts, live SSE contracts, auth headers, warnings/errors, cursors, limits, and unsupported paths.
`docs/development.md`	DOC-02I	Workspace layout, codegen, build/test/clippy commands, integration harnesses, UI test boundaries, Gantt generation, review gates, and planning rules.
`docs/troubleshooting.md`	DOC-02J	Common ingest, auth/TLS, queue/spool, object-store, query warning, oversized-record, live-view, and conflict recovery checks.
`docs/release-upgrade-notes.md`	DOC-02J	Schema/config changes, data compatibility, migration steps, and release caveats.

Excluded

Not Published As Public Docs

Path	Reason
`AGENTS.md`	Repository-local agent operating instructions are not public product documentation.
`REVIEW.md`	Maintainer review gates are used for development process, not published as user-facing docs.
`docs/worklog/`	Structured completed-slice records stay source-linked; public pages consume summarized roadmap metadata instead.
`docs/gantt-data.js`	The local file:// wrapper is excluded; the public site consumes the canonical JSON payload.