README.md

Project Documentation

This directory contains project documentation that is not part of the primary user-facing root README.

Start here when looking for development, architecture, release, or maintenance documentation.

Main Entry Points

• Product and design principles
• Backend architecture
• External components / Japanese
• Windows sensor external components
• Architecture decision records
• Lossless chunked Hardware Archive decision
• Hardware Archive migration lifecycle proposal
• Native DuckDB direction decision
• SQLite conversion path retirement decision
• Native DuckDB Hardware Archive Design Doc
• External Component Setup decision
• External Component Setup Design Doc
• Native DuckDB distribution and durability evidence
• Native DuckDB retention, checkpoint and reuse evidence
• Earlier SQLite chunk candidate
• Hardware Archive investigation and work tracking
• Relicense to GPL-3.0-or-later decision
• Sensor hardware specs (clean-room)
• Frontend architecture
• Frontend layer boundaries decision
• Frontend architecture Design Doc
• Core crate guide
• Tauri app crate guide
• Add a new language
• E2E capture harness
• Super I/O sensor work handoff
• GitHub label guide
• CI fast feedback
• Local build cache across git worktrees
• CI telemetry
• Download verification
• Release vulnerability response
• Documentation guide
• Shared agent rules
• AI learning records

Documentation Map

docs/
├── README.md                       # Documentation index
├── design-principles.md            # Product and engineering decision lens
├── documentation-guide.md          # Documentation placement and naming rules
├── agents/                         # AI learning provenance and promotion records
├── adr/                            # Architecture decision records
├── architecture/                   # Architecture documents
├── development/                    # Developer task guides
├── specs/                          # Clean-room hardware specification documents
│   └── sensors/                    # Sensor specs for PawnIO-based monitoring
├── security/                       # Release security response and evidence policy
├── licenses/                       # License info, generated + manual third-party notices
│   ├── LICENSE_INFORMATION.md      # GPL relicensing / pre-relicense MIT notice
│   ├── MIT-pre-relicense.txt       # MIT text for code predating the relicense
│   ├── linux/                      # Generated Linux THIRD_PARTY_NOTICES.md
│   ├── windows/                    # Generated Windows THIRD_PARTY_NOTICES.md
│   ├── macos/                      # Generated macOS THIRD_PARTY_NOTICES.md
│   └── manual/                     # Manual third-party notice fragments
├── user/                           # User-facing guides published by the website
│   ├── external-components.md      # External component setup guide
│   └── external-components.ja.md   # Japanese external component setup guide
├── download-verification.md        # Download verification guide
├── download-verification.ja.md     # Japanese download verification guide
└── internal/                       # Maintainer/internal operations docs

Current Layout Notes

• The Japanese user-facing README lives at ../README.ja.md beside the English root README. It is not a translation of this documentation index.
• Documentation directories and handwritten Markdown files should use lowercase kebab-case. Generated legal notice files named THIRD_PARTY_NOTICES.md are the current exception.
• tmp/THIRD_PARTY_NOTICES.md is tracked and used as the current Tauri bundled third-party notices resource. Although it lives under tmp/, it is not a disposable scratch file. Moving it to a clearer runtime resource location, such as src-tauri/resources/THIRD_PARTY_NOTICES.md, should be handled as a separate release/bundling change.

Root-Level Documents

Some documents intentionally live at the repository root because GitHub or contributors expect them there:

• README.md
• CONTRIBUTING.md
• SECURITY.md
• CODE_SIGNING_POLICY.md
• LICENSE