trainlog/docs
2026-09-16 08:10:09 +02:00
..
design/app_shell_v1 feat(trainlog): complete app shell and exercise merge 2026-09-11 07:21:54 +02:00
domain feat(trainlog): complete app shell and exercise merge 2026-09-11 07:21:54 +02:00
reviews feat(trainlog): add synchronized training feedback 2026-09-12 18:34:53 +02:00
android.md chore: open development for v0.1.2 2026-09-16 07:49:14 +02:00
architecture.md test: freeze TUI dashboard behavior 2026-09-16 08:07:37 +02:00
coding_style.md feat(sync): stabilize bidirectional sync and equipment reconciliation 2026-09-08 17:57:03 +02:00
current_state.md test: freeze TUI dashboard behavior 2026-09-16 08:07:37 +02:00
database.md release: prepare Trainlog 0.1.0 baseline 2026-09-15 08:08:36 +02:00
exchange_format.md feat: add AI session draft sync workflow 2026-09-14 19:21:32 +02:00
exercise_data_model.md feat(trainlog): complete stats knowledge and sync hardening 2026-09-13 20:56:16 +02:00
README.md release: prepare Trainlog 0.1.1 2026-09-16 07:46:11 +02:00
roadmap.md test: freeze TUI dashboard behavior 2026-09-16 08:07:37 +02:00
sync_exchange.md feat: refine Android training UI and sync workflow 2026-09-14 20:07:30 +02:00
tests.md test: cover dashboard legacy weight edges 2026-09-16 08:10:09 +02:00
training_feedback.md feat(trainlog): complete stats knowledge and sync hardening 2026-09-13 20:56:16 +02:00
tui.md test: cover dashboard legacy weight edges 2026-09-16 08:10:09 +02:00

Trainlog documentation

This file is the canonical documentation index. Canonical documents describe the current contract or state; reviews/ and CHANGELOG.md retain historical evidence and chronology.

Start here

  • Current state owns present schemas, capabilities, validation, and active limitations.
  • Architecture owns component, process, storage, transport, and responsibility boundaries.
  • Roadmap owns the current cursor and future work.

Interfaces

  • Android owns field-companion capture, local persistence, glanceable summaries, permissions, and Android interaction rules.
  • Desktop TUI owns Notcurses navigation, correction, detailed consultation, analytics, graphs, and long-term follow-up behavior.
  • Architecture owns the contract for the planned local Web sibling, including Core/API boundaries, loopback networking, shell, Dashboard, layout, build/runtime separation, and security invariants.

Data model

  • Exercise data model owns exercise profiles, occurrence identity, planned-versus-actual work, load, and MAX semantics.
  • Database owns desktop SQLite tables, constraints, transactions, and migrations.
  • Training feedback owns immediate feedback, immutable revisions, and J+1/session follow-up semantics.
  • Domain documentation owns cited anatomy, biomechanics, equipment interpretation, training knowledge, and session-generation science.

Synchronization and exchange

  • Synchronization exchange owns the active MTP workflow, artifact direction, replay, publication, receipts, and daemon behavior.
  • Exchange formats owns frozen Trainlog JSON V1 and separately versioned contracts, including AI exchange definitions.

Analytics

  • Desktop TUI owns visible statistics, MAX, body analytics, calendar buckets, and graph behavior.
  • Current state records which analytics are implemented.
  • Exercise data model owns the distinctions between measured MAX, performed work, plans, and estimates.

Development

Design

  • Design records retain proposals and design-gate evidence. They are not the authority for current implementation status.

Reviews and history

  • Review records retain historical audits, incidents, checkpoints, and validation evidence. Their status and paths are historical.
  • Changelog owns chronological change history.

Ownership rule

Do not copy long normative explanations between documents. The repository README.md is the entry point, this file is the index, current_state.md is the snapshot, and roadmap.md is future-oriented.