Files
pi-gui/docs/README.md
T
alex 7cc15cca92 docs: establish project documentation baseline
Provide installation, security, contribution, licensing, and release guidance while removing user-specific service configuration.
2026-07-27 15:15:56 +02:00

1004 B

Documentation index

Reason for existence

Point contributors and operators to the authoritative document for each concern without duplicating implementation detail.

Need Authoritative document
Install, run, and verify the project ../README.md
Understand boundaries and security invariants ../DESIGN.md
Follow implementation milestones ../IMPLEMENTATION_PLAN.md
Execute acceptance and soak testing ../TEST_PLAN.md
Understand the desktop product surface ../specs/FULL_PI_PANEL_SPEC.md
Understand Tauri integration ../specs/TAURI_CLIENT_ARCHITECTURE.md
Contribute safely ../CONTRIBUTING.md
Report vulnerabilities ../SECURITY.md

Verification

test -f README.md && test -f DESIGN.md && test -f TEST_PLAN.md