docs: fix stale links and remove mispositioned repo-local guide from storefronts

Fix the 12 relative links broken since before this branch (defunct
docs/truth/workflows/ paths, moved .codex/skills/ -> .agents/skills/
paths, and one link to a test file that was never created) and correct
a stale generated-surfaces list in the same research note.

Remove "Maintaining repository truth" from all 16 READMEs and the user
guide's documentation list. It links docs/repo/standards/maintaining-
repository-truth.md, which states it is for Truthmark's own maintainers
and carries scope: repo-local, but sat in storefront lists next to
product-facing docs as if it were guidance for people installing
Truthmark.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This commit is contained in:
MerlinH
2026-08-23 13:46:37 +00:00
co-authored by Claude Sonnet 5
parent b0a06b5566
commit 4d3cf2922d
20 changed files with 43 additions and 37 deletions
-1
View File
@@ -185,7 +185,6 @@ Structured JSON output is available throughout the command-line interface for sc
- [Documentation index](https://github.com/merlinhu1/truthmark/blob/main/docs/README.md)
- [Architecture overview](https://github.com/merlinhu1/truthmark/blob/main/docs/truthmark/engineering/architecture/overview.md)
- [Configuration, routing, and command contracts](https://github.com/merlinhu1/truthmark/blob/main/docs/truthmark/engineering/contracts/config-route-and-check-contracts.md)
- [Maintaining repository truth](https://github.com/merlinhu1/truthmark/blob/main/docs/repo/standards/maintaining-repository-truth.md)
- [Contributing](https://github.com/merlinhu1/truthmark/blob/main/CONTRIBUTING.md)
**Install Truthmark, select your coding host, and turn one real behavior into documentation today.**
+23
View File
@@ -0,0 +1,23 @@
# Fix Stale Documentation Links
Version action: none
## PR Summary
- Fixed all 12 relative links broken since before this branch, all inside `docs/repo/research/`: 11 in `2026-05-15-agent-skills-workflow-review.md` pointed at a defunct `docs/truth/workflows/` tree and `.codex/skills/` paths that moved to `.agents/skills/`; 1 in `2026-06-29-manual-agent-skill-quality-eval-framework.md` cited a `tests/evals/workflow-eval-framwork.test.ts` that was never created, replaced with the actual routing-case fixture file it should have pointed to.
- Corrected a stale generated-surfaces list in the same 2026-05-15 note (it still named `.codex/skills/`, `.github/prompts/`, `.github/agents/`, and a `.gemini/commands/truthmark/` path that never existed in the schema) to match what this repository actually installs.
- Removed the "Maintaining repository truth" link from the root README and all 15 localized READMEs. That guide's own text says "This guide is for humans maintaining Truthmark's own docs tree" — it is repo-local content (`docs/repo/standards/maintaining-repository-truth.md`, `scope: repo-local`), but the storefront "Learn more" section presented it alongside product-facing docs (User Guide, Architecture overview, Configuration contracts) as if it were guidance for people installing Truthmark. Removed the same mispositioned link from `docs/user-guide.md`'s documentation list for the same reason.
A full relative-link audit across every tracked Markdown file now reports zero broken links, down from a 12-link baseline that predates this branch.
## Release Note
- None; internal-only documentation fixes. No `src/` behavior changed.
## Verification
- `npm run lint`
- `npm run typecheck`
- `npm test` (423 pass, 0 fail)
- `npm run dev -- check` (no diagnostics)
- Relative-link audit across all tracked Markdown: 0 broken (was 12).
-1
View File
@@ -185,7 +185,6 @@ truthmark check --base <base-ref>
- [فهرس التوثيق](https://github.com/merlinhu1/truthmark/blob/main/docs/README.md)
- [نظرة عامة على المعمارية](https://github.com/merlinhu1/truthmark/blob/main/docs/truthmark/engineering/architecture/overview.md)
- [عقود الإعداد والتوجيه والأوامر](https://github.com/merlinhu1/truthmark/blob/main/docs/truthmark/engineering/contracts/config-route-and-check-contracts.md)
- [صيانة حقيقة المستودع](https://github.com/merlinhu1/truthmark/blob/main/docs/repo/standards/maintaining-repository-truth.md)
- [المساهمة](https://github.com/merlinhu1/truthmark/blob/main/CONTRIBUTING.md)
**ثبّت Truthmark، واختر مضيف البرمجة، وحوّل سلوكاً حقيقياً إلى توثيق اليوم.**
-1
View File
@@ -185,7 +185,6 @@ Strukturierte JSON-Ausgabe ist in der gesamten Befehlszeilenschnittstelle für S
- [Dokumentationsindex](https://github.com/merlinhu1/truthmark/blob/main/docs/README.md)
- [Architekturüberblick](https://github.com/merlinhu1/truthmark/blob/main/docs/truthmark/engineering/architecture/overview.md)
- [Konfigurations-, Routing- und Befehlsverträge](https://github.com/merlinhu1/truthmark/blob/main/docs/truthmark/engineering/contracts/config-route-and-check-contracts.md)
- [Repository-Wahrheit pflegen](https://github.com/merlinhu1/truthmark/blob/main/docs/repo/standards/maintaining-repository-truth.md)
- [Mitwirken](https://github.com/merlinhu1/truthmark/blob/main/CONTRIBUTING.md)
**Installiere Truthmark, wähle deinen Coding-Host und verwandle noch heute ein echtes Verhalten in Dokumentation.**
-1
View File
@@ -185,7 +185,6 @@ truthmark check --base <base-ref>
- [Ευρετήριο τεκμηρίωσης](https://github.com/merlinhu1/truthmark/blob/main/docs/README.md)
- [Επισκόπηση αρχιτεκτονικής](https://github.com/merlinhu1/truthmark/blob/main/docs/truthmark/engineering/architecture/overview.md)
- [Συμβόλαια διαμόρφωσης, δρομολόγησης και εντολών](https://github.com/merlinhu1/truthmark/blob/main/docs/truthmark/engineering/contracts/config-route-and-check-contracts.md)
- [Συντήρηση της αλήθειας του αποθετηρίου](https://github.com/merlinhu1/truthmark/blob/main/docs/repo/standards/maintaining-repository-truth.md)
- [Συνεισφορά](https://github.com/merlinhu1/truthmark/blob/main/CONTRIBUTING.md)
**Εγκαταστήστε το Truthmark, επιλέξτε τον host προγραμματισμού σας και μετατρέψτε σήμερα μία πραγματική συμπεριφορά σε τεκμηρίωση.**
-1
View File
@@ -185,7 +185,6 @@ La salida JSON estructurada está disponible en toda la interfaz de línea de co
- [Índice de documentación](https://github.com/merlinhu1/truthmark/blob/main/docs/README.md)
- [Descripción general de la arquitectura](https://github.com/merlinhu1/truthmark/blob/main/docs/truthmark/engineering/architecture/overview.md)
- [Contratos de configuración, enrutamiento y comandos](https://github.com/merlinhu1/truthmark/blob/main/docs/truthmark/engineering/contracts/config-route-and-check-contracts.md)
- [Mantenimiento de la verdad del repositorio](https://github.com/merlinhu1/truthmark/blob/main/docs/repo/standards/maintaining-repository-truth.md)
- [Contribuir](https://github.com/merlinhu1/truthmark/blob/main/CONTRIBUTING.md)
**Instala Truthmark, selecciona tu host de programación y convierte hoy un comportamiento real en documentación.**
-1
View File
@@ -185,7 +185,6 @@ Une sortie JSON structurée est disponible dans toute linterface en ligne de
- [Index de la documentation](https://github.com/merlinhu1/truthmark/blob/main/docs/README.md)
- [Vue densemble de larchitecture](https://github.com/merlinhu1/truthmark/blob/main/docs/truthmark/engineering/architecture/overview.md)
- [Contrats de configuration, de routage et de commande](https://github.com/merlinhu1/truthmark/blob/main/docs/truthmark/engineering/contracts/config-route-and-check-contracts.md)
- [Maintenir la vérité du dépôt](https://github.com/merlinhu1/truthmark/blob/main/docs/repo/standards/maintaining-repository-truth.md)
- [Contribuer](https://github.com/merlinhu1/truthmark/blob/main/CONTRIBUTING.md)
**Installez Truthmark, sélectionnez votre hôte de codage et transformez dès aujourdhui un comportement réel en documentation.**
-1
View File
@@ -185,7 +185,6 @@ Output JSON terstruktur tersedia di seluruh antarmuka baris perintah untuk skrip
- [Indeks dokumentasi](https://github.com/merlinhu1/truthmark/blob/main/docs/README.md)
- [Ikhtisar arsitektur](https://github.com/merlinhu1/truthmark/blob/main/docs/truthmark/engineering/architecture/overview.md)
- [Kontrak konfigurasi, perutean, dan perintah](https://github.com/merlinhu1/truthmark/blob/main/docs/truthmark/engineering/contracts/config-route-and-check-contracts.md)
- [Memelihara kebenaran repositori](https://github.com/merlinhu1/truthmark/blob/main/docs/repo/standards/maintaining-repository-truth.md)
- [Berkontribusi](https://github.com/merlinhu1/truthmark/blob/main/CONTRIBUTING.md)
**Pasang Truthmark, pilih host pengodean Anda, dan ubah satu perilaku nyata menjadi dokumentasi hari ini.**
-1
View File
@@ -185,7 +185,6 @@ Loutput JSON strutturato è disponibile in tutta linterfaccia a riga di co
- [Indice della documentazione](https://github.com/merlinhu1/truthmark/blob/main/docs/README.md)
- [Panoramica dellarchitettura](https://github.com/merlinhu1/truthmark/blob/main/docs/truthmark/engineering/architecture/overview.md)
- [Contratti di configurazione, routing e comandi](https://github.com/merlinhu1/truthmark/blob/main/docs/truthmark/engineering/contracts/config-route-and-check-contracts.md)
- [Manutenzione della verità del repository](https://github.com/merlinhu1/truthmark/blob/main/docs/repo/standards/maintaining-repository-truth.md)
- [Contribuire](https://github.com/merlinhu1/truthmark/blob/main/CONTRIBUTING.md)
**Installa Truthmark, seleziona il tuo host di coding e trasforma oggi stesso un comportamento reale in documentazione.**
-1
View File
@@ -185,7 +185,6 @@ Truthmark は、すでに AI コーディングエージェントを利用し、
- [ドキュメント索引](https://github.com/merlinhu1/truthmark/blob/main/docs/README.md)
- [アーキテクチャ概要](https://github.com/merlinhu1/truthmark/blob/main/docs/truthmark/engineering/architecture/overview.md)
- [設定、ルーティング、コマンドの契約](https://github.com/merlinhu1/truthmark/blob/main/docs/truthmark/engineering/contracts/config-route-and-check-contracts.md)
- [リポジトリの事実を維持する](https://github.com/merlinhu1/truthmark/blob/main/docs/repo/standards/maintaining-repository-truth.md)
- [コントリビューション](https://github.com/merlinhu1/truthmark/blob/main/CONTRIBUTING.md)
**Truthmark をインストールし、コーディングホストを選び、今日から実際の振る舞いをドキュメントに変えましょう。**
-1
View File
@@ -185,7 +185,6 @@ Truthmark는 이미 AI 코딩 에이전트를 사용하며, 코드가 변하는
- [문서 색인](https://github.com/merlinhu1/truthmark/blob/main/docs/README.md)
- [아키텍처 개요](https://github.com/merlinhu1/truthmark/blob/main/docs/truthmark/engineering/architecture/overview.md)
- [구성, 라우팅, 명령 계약](https://github.com/merlinhu1/truthmark/blob/main/docs/truthmark/engineering/contracts/config-route-and-check-contracts.md)
- [저장소의 진실 유지관리](https://github.com/merlinhu1/truthmark/blob/main/docs/repo/standards/maintaining-repository-truth.md)
- [기여하기](https://github.com/merlinhu1/truthmark/blob/main/CONTRIBUTING.md)
**Truthmark를 설치하고 코딩 호스트를 선택해 오늘 바로 실제 동작 하나를 문서로 바꾸세요.**
-1
View File
@@ -185,7 +185,6 @@ Strukturyzowane dane wyjściowe JSON są dostępne w całym interfejsie wiersza
- [Indeks dokumentacji](https://github.com/merlinhu1/truthmark/blob/main/docs/README.md)
- [Przegląd architektury](https://github.com/merlinhu1/truthmark/blob/main/docs/truthmark/engineering/architecture/overview.md)
- [Kontrakty konfiguracji, routingu i poleceń](https://github.com/merlinhu1/truthmark/blob/main/docs/truthmark/engineering/contracts/config-route-and-check-contracts.md)
- [Utrzymywanie prawdy repozytorium](https://github.com/merlinhu1/truthmark/blob/main/docs/repo/standards/maintaining-repository-truth.md)
- [Współtworzenie](https://github.com/merlinhu1/truthmark/blob/main/CONTRIBUTING.md)
**Zainstaluj Truthmark, wybierz host programistyczny i już dziś zamień jedno rzeczywiste zachowanie w dokumentację.**
-1
View File
@@ -185,7 +185,6 @@ A saída JSON estruturada está disponível em toda a interface de linha de coma
- [Índice da documentação](https://github.com/merlinhu1/truthmark/blob/main/docs/README.md)
- [Visão geral da arquitetura](https://github.com/merlinhu1/truthmark/blob/main/docs/truthmark/engineering/architecture/overview.md)
- [Contratos de configuração, roteamento e comandos](https://github.com/merlinhu1/truthmark/blob/main/docs/truthmark/engineering/contracts/config-route-and-check-contracts.md)
- [Manutenção da verdade do repositório](https://github.com/merlinhu1/truthmark/blob/main/docs/repo/standards/maintaining-repository-truth.md)
- [Como contribuir](https://github.com/merlinhu1/truthmark/blob/main/CONTRIBUTING.md)
**Instale o Truthmark, selecione seu host de programação e transforme hoje um comportamento real em documentação.**
-1
View File
@@ -185,7 +185,6 @@ Truthmark создан для сопровождающих и инженерны
- [Индекс документации](https://github.com/merlinhu1/truthmark/blob/main/docs/README.md)
- [Обзор архитектуры](https://github.com/merlinhu1/truthmark/blob/main/docs/truthmark/engineering/architecture/overview.md)
- [Контракты конфигурации, маршрутизации и команд](https://github.com/merlinhu1/truthmark/blob/main/docs/truthmark/engineering/contracts/config-route-and-check-contracts.md)
- [Поддержание достоверности репозитория](https://github.com/merlinhu1/truthmark/blob/main/docs/repo/standards/maintaining-repository-truth.md)
- [Участие в разработке](https://github.com/merlinhu1/truthmark/blob/main/CONTRIBUTING.md)
**Установите Truthmark, выберите хост разработки и уже сегодня превратите реальное поведение в документацию.**
-1
View File
@@ -185,7 +185,6 @@ Betikler ve sürekli entegrasyon için komut satırı arayüzünün tamamında y
- [Dokümantasyon dizini](https://github.com/merlinhu1/truthmark/blob/main/docs/README.md)
- [Mimariye genel bakış](https://github.com/merlinhu1/truthmark/blob/main/docs/truthmark/engineering/architecture/overview.md)
- [Yapılandırma, yönlendirme ve komut sözleşmeleri](https://github.com/merlinhu1/truthmark/blob/main/docs/truthmark/engineering/contracts/config-route-and-check-contracts.md)
- [Depo gerçeğini koruma](https://github.com/merlinhu1/truthmark/blob/main/docs/repo/standards/maintaining-repository-truth.md)
- [Katkıda bulunma](https://github.com/merlinhu1/truthmark/blob/main/CONTRIBUTING.md)
**Truthmark'ı kurun, kodlama ana bilgisayarınızı seçin ve gerçek bir davranışı bugün belgeye dönüştürün.**
-1
View File
@@ -185,7 +185,6 @@ Các host tác nhân được hỗ trợ:
- [Chỉ mục tài liệu](https://github.com/merlinhu1/truthmark/blob/main/docs/README.md)
- [Tổng quan kiến trúc](https://github.com/merlinhu1/truthmark/blob/main/docs/truthmark/engineering/architecture/overview.md)
- [Hợp đồng cấu hình, định tuyến và lệnh](https://github.com/merlinhu1/truthmark/blob/main/docs/truthmark/engineering/contracts/config-route-and-check-contracts.md)
- [Duy trì sự thật của kho](https://github.com/merlinhu1/truthmark/blob/main/docs/repo/standards/maintaining-repository-truth.md)
- [Đóng góp](https://github.com/merlinhu1/truthmark/blob/main/CONTRIBUTING.md)
**Cài đặt Truthmark, chọn host lập trình và biến một hành vi thực tế thành tài liệu ngay hôm nay.**
-1
View File
@@ -185,7 +185,6 @@ Truthmark 专为已经使用 AI 编码代理,并希望仓库事实与代码同
- [文档索引](https://github.com/merlinhu1/truthmark/blob/main/docs/README.md)
- [架构概览](https://github.com/merlinhu1/truthmark/blob/main/docs/truthmark/engineering/architecture/overview.md)
- [配置、路由和命令契约](https://github.com/merlinhu1/truthmark/blob/main/docs/truthmark/engineering/contracts/config-route-and-check-contracts.md)
- [维护仓库事实](https://github.com/merlinhu1/truthmark/blob/main/docs/repo/standards/maintaining-repository-truth.md)
- [参与贡献](https://github.com/merlinhu1/truthmark/blob/main/CONTRIBUTING.md)
**立即安装 Truthmark,选择您的编码宿主,今天就把一个真实行为转化为文档。**
@@ -10,20 +10,20 @@ Status: research reference
Date: 2026-05-15
Audience: Truthmark maintainers
This is a non-canonical research reference. It summarizes external skill-authoring guidance reviewed on 2026-05-15 and applies it to Truthmark's installed project workflows. It must not be treated as current Truthmark behavior unless the behavior-bearing parts are promoted into [workflow overview](../docs/truth/workflows/overview.md), the bounded workflow truth docs under `docs/truth/workflows/`, the workflow manifest, renderers, and tests.
This is a non-canonical research reference. It summarizes external skill-authoring guidance reviewed on 2026-05-15 and applies it to Truthmark's installed project workflows. It must not be treated as current Truthmark behavior unless the behavior-bearing parts are promoted into [installed workflow runtime](../../truthmark/engineering/workflows/installed-workflow-runtime.md), the workflow manifest, renderers, and tests.
Checkout references:
- [docs/ai/repo-rules.md](../docs/ai/repo-rules.md)
- [docs/truth/workflows/overview.md](../docs/truth/workflows/overview.md)
- [docs/truth/workflows/shared-gates.md](../docs/truth/workflows/shared-gates.md)
- [src/agents/workflow-manifest.ts](../src/agents/workflow-manifest.ts)
- [src/templates/workflow-surfaces.ts](../src/templates/workflow-surfaces.ts)
- [.codex/skills/truthmark-sync/SKILL.md](../.codex/skills/truthmark-sync/SKILL.md)
- [.codex/skills/truthmark-structure/SKILL.md](../.codex/skills/truthmark-structure/SKILL.md)
- [.codex/skills/truthmark-document/SKILL.md](../.codex/skills/truthmark-document/SKILL.md)
- [.codex/skills/truthmark-realize/SKILL.md](../.codex/skills/truthmark-realize/SKILL.md)
- [.codex/skills/truthmark-check/SKILL.md](../.codex/skills/truthmark-check/SKILL.md)
- [docs/repo/ai/repo-rules.md](../ai/repo-rules.md)
- [docs/truthmark/engineering/workflows/installed-workflow-runtime.md](../../truthmark/engineering/workflows/installed-workflow-runtime.md)
- [src/agents/workflow-manifest.ts](../../../src/agents/workflow-manifest.ts)
- [src/agents/shared.ts](../../../src/agents/shared.ts)
- [src/templates/workflow-surfaces.ts](../../../src/templates/workflow-surfaces.ts)
- [.agents/skills/truthmark-sync/SKILL.md](../../../.agents/skills/truthmark-sync/SKILL.md)
- [.agents/skills/truthmark-structure/SKILL.md](../../../.agents/skills/truthmark-structure/SKILL.md)
- [.agents/skills/truthmark-document/SKILL.md](../../../.agents/skills/truthmark-document/SKILL.md)
- [.agents/skills/truthmark-realize/SKILL.md](../../../.agents/skills/truthmark-realize/SKILL.md)
- [.agents/skills/truthmark-check/SKILL.md](../../../.agents/skills/truthmark-check/SKILL.md)
External sources reviewed:
@@ -85,7 +85,7 @@ Truthmark currently installs five workflows across host-specific surfaces:
| `truthmark-realize` | Realize truth docs into functional code | `allow_implicit_invocation: false` |
| `truthmark-check` | Audit repository truth health | `allow_implicit_invocation: false` |
Generated runtime surfaces include `.codex/skills/`, `.codex/agents/`, `.claude/skills/`, `.opencode/skills/`, `.opencode/agents/`, `.github/prompts/`, `.github/agents/`, `.gemini/commands/truthmark/`, and compact managed instruction blocks in files such as `AGENTS.md`.
Generated runtime surfaces include `.agents/skills/`, `.codex/agents/`, `.claude/skills/`, `.claude/agents/`, `.opencode/skills/`, `.opencode/agents/`, `.cursor/skills/`, `.antigravity/rules/`, and compact managed instruction blocks in files such as `AGENTS.md`.
Current strengths:
@@ -4,10 +4,10 @@ scope: repo-local
doc_type: research-index
last_reviewed: 2026-06-29
source_of_truth:
- ../../workflow-eval-framwork/README.md
- ../../workflow-eval-framwork/catalog.yaml
- ../../scripts/workflow-eval-framwork/run-agent-scenario.mjs
- ../../tests/evals/workflow-eval-framwork.test.ts
- ../../../workflow-eval-framwork/README.md
- ../../../workflow-eval-framwork/catalog.yaml
- ../../../scripts/workflow-eval-framwork/run-agent-scenario.mjs
- ../../../tests/evals/workflow-routing-cases.ts
---
# Manual Agent Skill And Prompt Quality Eval Framework
@@ -16,10 +16,10 @@ The implemented manual evaluation framework lives under `workflow-eval-framwork/
Use these artifacts:
- Framework README: [`../../workflow-eval-framwork/README.md`](../../../workflow-eval-framwork/README.md)
- Catalog: [`../../workflow-eval-framwork/catalog.yaml`](../../../workflow-eval-framwork/catalog.yaml)
- Manual runner: [`../../scripts/workflow-eval-framwork/run-agent-scenario.mjs`](../../../scripts/workflow-eval-framwork/run-agent-scenario.mjs)
- Schema and fake-runner tests: [`../../tests/evals/workflow-eval-framwork.test.ts`](../../../tests/evals/workflow-eval-framwork.test.ts)
- Framework README: [`workflow-eval-framwork/README.md`](../../../workflow-eval-framwork/README.md)
- Catalog: [`workflow-eval-framwork/catalog.yaml`](../../../workflow-eval-framwork/catalog.yaml)
- Manual runner: [`scripts/workflow-eval-framwork/run-agent-scenario.mjs`](../../../scripts/workflow-eval-framwork/run-agent-scenario.mjs)
- Routing case fixtures: [`tests/evals/workflow-routing-cases.ts`](../../../tests/evals/workflow-routing-cases.ts)
The requested framework folder name is intentionally spelled `workflow-eval-framwork`.
-1
View File
@@ -500,7 +500,6 @@ Detailed current behavior lives under `docs/`:
- [Init and scaffold behavior](truthmark/engineering/behaviors/init-and-scaffold.md)
- [Check diagnostics](truthmark/engineering/behaviors/check-diagnostics.md)
- [Installed workflows](truthmark/engineering/workflows/installed-workflow-runtime.md)
- [Repository truth maintenance guide](repo/standards/maintaining-repository-truth.md)
## Design boundaries