/truthmark-documentDocument what already exists
Read implementation and tests, then create or update bounded truth docs without changing functional code.
diff --git a/docs/truthmark/engineering/operations/release-automation.md b/docs/truthmark/engineering/operations/release-automation.md index 1d277aa..d719c1a 100644 --- a/docs/truthmark/engineering/operations/release-automation.md +++ b/docs/truthmark/engineering/operations/release-automation.md @@ -1,7 +1,7 @@ --- status: active truth_kind: engineering-operations -last_reviewed: 2026-06-26 +last_reviewed: 2026-07-26 --- # Release Automation @@ -22,6 +22,10 @@ The npm publish workflow runs from `release/**` tag push events, with manual `wo The GitHub Pages workflow deploys the committed static introduction site from `site/**` after pushes to `main` that change the site or Pages workflow. +The static introduction site replaces the positioned hero illustration with a bounded grid at narrow desktop and tablet widths, then stacks the same content at phone widths. The header brand mark uses an inline SVG checkmark that remains contained within its rounded glyph. + +The introduction site groups its overview, workflow guide, truth model, and adoption content into hash-addressable tab pages. The static page keeps each view in the committed HTML, uses client-side navigation as progressive enhancement, and keeps the selected tab visible inside the horizontally scrollable phone navigation. + CodeQL is handled by GitHub's default setup for this repository. Checked-in advanced CodeQL workflow configuration is intentionally absent while default setup is enabled. diff --git a/site/index.html b/site/index.html index 98edc4f..9180806 100644 --- a/site/index.html +++ b/site/index.html @@ -1,8 +1,9 @@ - +
+Truthmark gives AI-assisted work a reviewable truth layer: current claims, ownership routes, product promises, and implementation facts travel with the same Git branch as the code.
-Truthmark does not turn every activity into a command. Three workflows are clear user entry points; Sync closes functional code changes; Structure appears only when ownership needs repair.
/truthmark-documentRead implementation and tests, then create or update bounded truth docs without changing functional code.
/truthmark-realizeUse product truth as requirements and engineering truth as implementation context. The source docs remain unchanged.
/truthmark-checkInspect routing, evidence, lane shape, and truth health without authorizing writes.
Truth SyncAfter functional code changes, review mapped truth, capture supported decisions, and update or explicitly leave claims unchanged with evidence.
Truth StructureSplit broad routes and overgrown docs when the repository can no longer identify a bounded owner.
Truthmark links what users can rely on to how the repository currently realizes it. The relationship is explicit, but neither document inherits authority from the other.
Truthmark can let product and engineering documents reference each other without forcing them into the same voice or authority level.
The route map decides ownership, truth docs preserve current claims, and host-native guidance tells the coding agent when each surface may change.
Changed paths map to an area and its canonical product or engineering truth docs.
Human-facing Markdown records current behavior, rationale, boundaries, and evidence in the right lane.
Committed skills, prompts, commands, and instruction blocks carry write boundaries into normal coding work.
Truthmark's ambition is in the repository model, not in requiring every contributor to adopt a new always-on system.
Choose the agent host your team already uses. Truthmark commits its guidance, routes, and truth docs to the repository, so the next branch can continue without a background service.
Install once, commit the workflow surface, and let future branches carry their truth updates through normal review.
$ cd /path/to/your-repo + $ cd /path/to/your-repo $ npm install -g truthmark $ truthmark config +# Add the host you use to .truthmark/config.yml, for example: platforms: [codex] $ truthmark init $ truthmark check -# After setup, agent guidance and truth routes live in the checkout.
Every durable surface can be reviewed, blamed, reverted, and carried by the branch.
+Document one implemented behavior with code and test evidence. Then keep coding normally and let finish-time Sync review future changes.
+This website explains the product. Canonical behavior remains in the repository's README, routed truth docs, source, tests, and configuration. Truthmark adds no required daemon, database, hosted service, or hidden memory layer.