History

fy59 14b863eb0f test(sync): add isolated validation harness		2026-09-17 06:31:07 +02:00
..
design	test(sync): add isolated validation harness	2026-09-17 06:31:07 +02:00
domain	feat(trainlog): complete app shell and exercise merge	2026-09-11 07:21:54 +02:00
reviews	fix(web): complete dashboard v1 final review	2026-09-16 21:26:43 +02:00
android.md	chore: open development for v0.1.2	2026-09-16 07:49:14 +02:00
architecture.md	fix(web): complete dashboard v1 final review	2026-09-16 21:26:43 +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(sync): add isolated validation harness	2026-09-17 06:31:07 +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	docs(sync): freeze complete synchronization gap contract	2026-09-16 22:07:55 +02:00
roadmap.md	test(sync): add isolated validation harness	2026-09-17 06:31:07 +02:00
sync_exchange.md	docs(sync): freeze complete synchronization gap contract	2026-09-16 22:07:55 +02:00
tests.md	test(sync): add isolated validation harness	2026-09-17 06:31:07 +02:00
training_feedback.md	feat(trainlog): complete stats knowledge and sync hardening	2026-09-13 20:56:16 +02:00
tui.md	refactor(core): extract dashboard read model	2026-09-16 08:26:48 +02:00

README.md

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.
Complete synchronization gap contract freezes the future lifecycle, causal deletion, generation, consumption, acknowledgement and Web-service requirements. It is explicitly not an implemented wire format.
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

Tests and validation owns durable build, test, sanitizer, contract, and hardware-validation commands.
Coding style owns C17/Kotlin style and comment rules.
Development contract owns frozen boundaries, invariants, validation policy, and safe device-testing policy.
Android build notes are the Android setup entry point.
Format material indexes frozen schema assets.

Design

Design records retain proposals and design-gate evidence. The synchronization gap contract is normative for future implementation; design records do not override current_state.md for implemented 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.