From 5050eb0fb7829c974d4cfc8daecb888f44ef8747 Mon Sep 17 00:00:00 2001 From: MerlinH Date: Sat, 1 Aug 2026 16:51:39 +0000 Subject: [PATCH] docs: replace README diagram with responsive visual --- README.md | 15 +- docs/assets/truthmark-workflow-mobile.svg | 118 ++++++++++++++ docs/assets/truthmark-workflow.svg | 182 ++++++++++++++++++++++ docs/readmes/README.ar.md | 15 +- docs/readmes/README.de.md | 15 +- docs/readmes/README.el.md | 15 +- docs/readmes/README.es.md | 15 +- docs/readmes/README.fr.md | 15 +- docs/readmes/README.id.md | 15 +- docs/readmes/README.it.md | 15 +- docs/readmes/README.ja.md | 15 +- docs/readmes/README.ko.md | 15 +- docs/readmes/README.pl.md | 15 +- docs/readmes/README.pt.md | 15 +- docs/readmes/README.ru.md | 15 +- docs/readmes/README.tr.md | 15 +- docs/readmes/README.vi.md | 15 +- docs/readmes/README.zh.md | 15 +- package.json | 2 + tests/package-files.test.ts | 2 + 20 files changed, 368 insertions(+), 176 deletions(-) create mode 100644 docs/assets/truthmark-workflow-mobile.svg create mode 100644 docs/assets/truthmark-workflow.svg diff --git a/README.md b/README.md index 4e58edd..7d49cfe 100644 --- a/README.md +++ b/README.md @@ -88,17 +88,10 @@ truthmark check --base ## How Truthmark works -```mermaid -flowchart LR - A["Existing code + tests"] --> B["Truth Document"] - B --> C["New product and engineering docs"] - D["Agent changes code"] --> E["Tests + Truth Sync"] - E --> F["Docs stay current"] - C --> G["Git review"] - F --> G - H["Truth docs"] --> I["Truth Realize"] - I --> D -``` + + + How Truthmark works + The Truthmark command-line interface installs and validates the repository contract. Your coding agent performs the evidence review and documentation work through the installed host-native workflows. diff --git a/docs/assets/truthmark-workflow-mobile.svg b/docs/assets/truthmark-workflow-mobile.svg new file mode 100644 index 0000000..6349a3b --- /dev/null +++ b/docs/assets/truthmark-workflow-mobile.svg @@ -0,0 +1,118 @@ + + How Truthmark works + Truthmark creates documentation from code and tests, keeps documentation current as code changes, and turns approved truth documents back into working code. Every path ends in one reviewable Git diff. + + + + + + + + + + + + + + + + + + + + + + + + TRUTHMARK + Create. Sync. Realize. + Documentation that moves with your code. + + + + + + + + + + + 01 · CREATE + Create from code + + Code + testsEvidence from working software + + + Truth Document + + + New product + engineering docs + + + + + + + + + + + 02 · SYNC + Stay current + + Agent changes codeTests prove the behavior + + + Truth Sync + + + Docs stay current before handoff + + + + + + + + + + + 03 · REALIZE + Build from truth + + Approved truth docsThe repository contract + + + Truth Realize + + + Working code implemented from truth + + + + + + + + + + ONE REVIEWABLE GIT DIFF + Code and documentation move together + with the branch. + + + + + diff --git a/docs/assets/truthmark-workflow.svg b/docs/assets/truthmark-workflow.svg new file mode 100644 index 0000000..97ef59d --- /dev/null +++ b/docs/assets/truthmark-workflow.svg @@ -0,0 +1,182 @@ + + How Truthmark works + Truthmark creates documentation from code and tests, keeps documentation current as code changes, and turns approved truth documents back into working code. Every path ends in one reviewable Git diff. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + TRUTHMARK + Create docs. Keep them true. Build from truth. + A complete documentation lifecycle inside your repository. + + + + + + + + + + + 01 · CREATE + Create from code + + + Code + tests + Evidence from working software + + + + Truth Document + + + + + + + + New truth docs + Product + engineering + + + + + + + + + + + 02 · SYNC + Stay current + + + Agent changes code + Tests prove the behavior + + + + Truth Sync + + + + + + + + Docs stay current + Before the agent hands off + + + + + + + + + + + 03 · REALIZE + Build from truth + + + Approved truth docs + The repository contract + + + + Truth Realize + + + + + + + Working code + Implemented from truth + + + + + + + + + + + + + + + ONE REVIEWABLE GIT DIFF + Code and documentation move together with the branch. + + + + + + + diff --git a/docs/readmes/README.ar.md b/docs/readmes/README.ar.md index b5b6a13..52ed7c8 100644 --- a/docs/readmes/README.ar.md +++ b/docs/readmes/README.ar.md @@ -88,17 +88,10 @@ truthmark check --base ## كيف يعمل Truthmark -```mermaid -flowchart LR - A["الكود والاختبارات الموجودة"] --> B["Truth Document"] - B --> C["توثيق جديد للمنتج والهندسة"] - D["الوكيل يغيّر الكود"] --> E["الاختبارات وTruth Sync"] - E --> F["الوثائق تبقى محدّثة"] - C --> G["المراجعة في Git"] - F --> G - H["وثائق الحقيقة"] --> I["Truth Realize"] - I --> D -``` + + + كيف يعمل Truthmark + تثبّت واجهة سطر أوامر Truthmark عقد المستودع وتتحقق منه. وينفّذ وكيل البرمجة مراجعة الأدلة وأعمال التوثيق من خلال مسارات العمل الأصلية للمضيف التي جرى تثبيتها. diff --git a/docs/readmes/README.de.md b/docs/readmes/README.de.md index f43be77..75ebb0c 100644 --- a/docs/readmes/README.de.md +++ b/docs/readmes/README.de.md @@ -88,17 +88,10 @@ truthmark check --base ## So funktioniert Truthmark -```mermaid -flowchart LR - A["Bestehender Code + Tests"] --> B["Truth Document"] - B --> C["Neue Produkt- und Engineering-Dokumentation"] - D["Agent ändert Code"] --> E["Tests + Truth Sync"] - E --> F["Dokumentation bleibt aktuell"] - C --> G["Git-Review"] - F --> G - H["Truth-Dokumente"] --> I["Truth Realize"] - I --> D -``` + + + So funktioniert Truthmark + Die Truthmark-Befehlszeilenschnittstelle installiert und validiert den Repository-Vertrag. Dein Coding-Agent prüft die Evidenz und erledigt die Dokumentationsarbeit über die installierten host-nativen Workflows. diff --git a/docs/readmes/README.el.md b/docs/readmes/README.el.md index 152676e..8df75fe 100644 --- a/docs/readmes/README.el.md +++ b/docs/readmes/README.el.md @@ -88,17 +88,10 @@ truthmark check --base ## Πώς λειτουργεί το Truthmark -```mermaid -flowchart LR - A["Υπάρχων κώδικας + tests"] --> B["Truth Document"] - B --> C["Νέα τεκμηρίωση προϊόντος και μηχανικής"] - D["Ο πράκτορας αλλάζει τον κώδικα"] --> E["Tests + Truth Sync"] - E --> F["Η τεκμηρίωση παραμένει ενημερωμένη"] - C --> G["Έλεγχος στο Git"] - F --> G - H["Έγγραφα truth"] --> I["Truth Realize"] - I --> D -``` + + + Πώς λειτουργεί το Truthmark + Η διεπαφή γραμμής εντολών του Truthmark εγκαθιστά και επικυρώνει το συμβόλαιο του αποθετηρίου. Ο πράκτορας προγραμματισμού σας εκτελεί την εξέταση αποδεικτικών στοιχείων και την εργασία τεκμηρίωσης μέσω των εγκατεστημένων, εγγενών ροών εργασίας του host. diff --git a/docs/readmes/README.es.md b/docs/readmes/README.es.md index 4b88f55..101e23d 100644 --- a/docs/readmes/README.es.md +++ b/docs/readmes/README.es.md @@ -88,17 +88,10 @@ truthmark check --base ## Cómo funciona Truthmark -```mermaid -flowchart LR - A["Código y pruebas existentes"] --> B["Truth Document"] - B --> C["Nueva documentación de producto e ingeniería"] - D["El agente cambia el código"] --> E["Pruebas y Truth Sync"] - E --> F["La documentación se mantiene actualizada"] - C --> G["Revisión en Git"] - F --> G - H["Documentos de verdad"] --> I["Truth Realize"] - I --> D -``` + + + Cómo funciona Truthmark + La interfaz de línea de comandos de Truthmark instala y valida el contrato del repositorio. Tu agente de programación realiza la revisión de evidencias y el trabajo de documentación mediante los flujos de trabajo nativos del host instalados. diff --git a/docs/readmes/README.fr.md b/docs/readmes/README.fr.md index 8d0dbf5..cd8f16d 100644 --- a/docs/readmes/README.fr.md +++ b/docs/readmes/README.fr.md @@ -88,17 +88,10 @@ truthmark check --base ## Fonctionnement de Truthmark -```mermaid -flowchart LR - A["Code existant + tests"] --> B["Truth Document"] - B --> C["Nouveaux documents produit et d’ingénierie"] - D["L’agent modifie le code"] --> E["Tests + Truth Sync"] - E --> F["Les documents restent à jour"] - C --> G["Revue Git"] - F --> G - H["Documents de vérité"] --> I["Truth Realize"] - I --> D -``` + + + Fonctionnement de Truthmark + L’interface en ligne de commande Truthmark installe et valide le contrat du dépôt. Votre agent de codage effectue l’examen des preuves et le travail documentaire via les workflows natifs de l’hôte qui ont été installés. diff --git a/docs/readmes/README.id.md b/docs/readmes/README.id.md index f6e2aa0..2d94ffa 100644 --- a/docs/readmes/README.id.md +++ b/docs/readmes/README.id.md @@ -88,17 +88,10 @@ truthmark check --base ## Cara kerja Truthmark -```mermaid -flowchart LR - A["Kode yang ada + pengujian"] --> B["Truth Document"] - B --> C["Dokumentasi produk dan rekayasa baru"] - D["Agen mengubah kode"] --> E["Pengujian + Truth Sync"] - E --> F["Dokumentasi tetap mutakhir"] - C --> G["Tinjauan Git"] - F --> G - H["Dokumen truth"] --> I["Truth Realize"] - I --> D -``` + + + Cara kerja Truthmark + Antarmuka baris perintah Truthmark memasang dan memvalidasi kontrak repositori. Agen pengodean Anda melakukan peninjauan bukti dan pekerjaan dokumentasi melalui alur kerja native host yang telah terpasang. diff --git a/docs/readmes/README.it.md b/docs/readmes/README.it.md index 2ace28a..9926f94 100644 --- a/docs/readmes/README.it.md +++ b/docs/readmes/README.it.md @@ -88,17 +88,10 @@ truthmark check --base ## Come funziona Truthmark -```mermaid -flowchart LR - A["Codice e test esistenti"] --> B["Truth Document"] - B --> C["Nuova documentazione di prodotto e ingegneria"] - D["L’agente modifica il codice"] --> E["Test e Truth Sync"] - E --> F["La documentazione resta aggiornata"] - C --> G["Revisione in Git"] - F --> G - H["Documenti di verità"] --> I["Truth Realize"] - I --> D -``` + + + Come funziona Truthmark + L’interfaccia a riga di comando di Truthmark installa e convalida il contratto del repository. Il tuo agente di coding esegue la revisione delle evidenze e il lavoro di documentazione attraverso i workflow nativi dell’host installati. diff --git a/docs/readmes/README.ja.md b/docs/readmes/README.ja.md index fd2b2b2..33d2da9 100644 --- a/docs/readmes/README.ja.md +++ b/docs/readmes/README.ja.md @@ -88,17 +88,10 @@ truthmark check --base ## Truthmark の仕組み -```mermaid -flowchart LR - A["既存のコード + テスト"] --> B["Truth Document"] - B --> C["新しいプロダクトおよびエンジニアリングドキュメント"] - D["エージェントがコードを変更"] --> E["テスト + Truth Sync"] - E --> F["ドキュメントを最新に維持"] - C --> G["Git レビュー"] - F --> G - H["Truth ドキュメント"] --> I["Truth Realize"] - I --> D -``` + + + Truthmark の仕組み + Truthmark のコマンドラインインターフェースがリポジトリ契約をインストールして検証します。コーディングエージェントは、インストール済みのホストネイティブなワークフローを通じて、証拠の確認とドキュメント作業を実行します。 diff --git a/docs/readmes/README.ko.md b/docs/readmes/README.ko.md index b525dd5..04124ec 100644 --- a/docs/readmes/README.ko.md +++ b/docs/readmes/README.ko.md @@ -88,17 +88,10 @@ truthmark check --base ## Truthmark 작동 방식 -```mermaid -flowchart LR - A["기존 코드 + 테스트"] --> B["Truth Document"] - B --> C["새 제품 및 엔지니어링 문서"] - D["에이전트가 코드 변경"] --> E["테스트 + Truth Sync"] - E --> F["문서를 최신 상태로 유지"] - C --> G["Git 검토"] - F --> G - H["Truth 문서"] --> I["Truth Realize"] - I --> D -``` + + + Truthmark 작동 방식 + Truthmark 명령줄 인터페이스는 저장소 계약을 설치하고 검증합니다. 코딩 에이전트는 설치된 호스트 네이티브 워크플로를 통해 근거를 검토하고 문서화 작업을 수행합니다. diff --git a/docs/readmes/README.pl.md b/docs/readmes/README.pl.md index 2f92077..4eb1bf4 100644 --- a/docs/readmes/README.pl.md +++ b/docs/readmes/README.pl.md @@ -88,17 +88,10 @@ truthmark check --base ## Jak działa Truthmark -```mermaid -flowchart LR - A["Istniejący kod + testy"] --> B["Truth Document"] - B --> C["Nowa dokumentacja produktu i inżynierii"] - D["Agent zmienia kod"] --> E["Testy + Truth Sync"] - E --> F["Dokumentacja pozostaje aktualna"] - C --> G["Przegląd w Git"] - F --> G - H["Dokumenty truth"] --> I["Truth Realize"] - I --> D -``` + + + Jak działa Truthmark + Interfejs wiersza poleceń Truthmark instaluje i sprawdza kontrakt repozytorium. Twój agent programistyczny analizuje dowody i wykonuje pracę dokumentacyjną za pomocą zainstalowanych, natywnych dla hosta przepływów pracy. diff --git a/docs/readmes/README.pt.md b/docs/readmes/README.pt.md index e276bbe..3722a5c 100644 --- a/docs/readmes/README.pt.md +++ b/docs/readmes/README.pt.md @@ -88,17 +88,10 @@ truthmark check --base ## Como o Truthmark funciona -```mermaid -flowchart LR - A["Código e testes existentes"] --> B["Truth Document"] - B --> C["Nova documentação de produto e engenharia"] - D["O agente altera o código"] --> E["Testes e Truth Sync"] - E --> F["A documentação permanece atualizada"] - C --> G["Revisão no Git"] - F --> G - H["Documentos de verdade"] --> I["Truth Realize"] - I --> D -``` + + + Como o Truthmark funciona + A interface de linha de comando do Truthmark instala e valida o contrato do repositório. Seu agente de programação realiza a revisão de evidências e o trabalho de documentação por meio dos fluxos de trabalho nativos do host que foram instalados. diff --git a/docs/readmes/README.ru.md b/docs/readmes/README.ru.md index d7f8035..09fb8fc 100644 --- a/docs/readmes/README.ru.md +++ b/docs/readmes/README.ru.md @@ -88,17 +88,10 @@ truthmark check --base ## Как работает Truthmark -```mermaid -flowchart LR - A["Существующий код и тесты"] --> B["Truth Document"] - B --> C["Новая продуктовая и инженерная документация"] - D["Агент изменяет код"] --> E["Тесты и Truth Sync"] - E --> F["Документация остаётся актуальной"] - C --> G["Проверка в Git"] - F --> G - H["Truth-документы"] --> I["Truth Realize"] - I --> D -``` + + + Как работает Truthmark + Интерфейс командной строки Truthmark устанавливает и проверяет контракт репозитория. Ваш агент разработки анализирует доказательства и работает с документацией через установленные нативные для хоста рабочие процессы. diff --git a/docs/readmes/README.tr.md b/docs/readmes/README.tr.md index 57397a4..15b3100 100644 --- a/docs/readmes/README.tr.md +++ b/docs/readmes/README.tr.md @@ -88,17 +88,10 @@ truthmark check --base ## Truthmark nasıl çalışır -```mermaid -flowchart LR - A["Mevcut kod + testler"] --> B["Truth Document"] - B --> C["Yeni ürün ve mühendislik belgeleri"] - D["Ajan kodu değiştirir"] --> E["Testler + Truth Sync"] - E --> F["Belgeler güncel kalır"] - C --> G["Git incelemesi"] - F --> G - H["Truth belgeleri"] --> I["Truth Realize"] - I --> D -``` + + + Truthmark nasıl çalışır + Truthmark komut satırı arayüzü depo sözleşmesini kurar ve doğrular. Kodlama ajanınız, kurulu ve ana bilgisayara özgü iş akışları üzerinden kanıt incelemesini ve dokümantasyon çalışmasını gerçekleştirir. diff --git a/docs/readmes/README.vi.md b/docs/readmes/README.vi.md index f9768d1..1c7f3b3 100644 --- a/docs/readmes/README.vi.md +++ b/docs/readmes/README.vi.md @@ -88,17 +88,10 @@ truthmark check --base ## Cách Truthmark hoạt động -```mermaid -flowchart LR - A["Mã hiện có + bài kiểm thử"] --> B["Truth Document"] - B --> C["Tài liệu sản phẩm và kỹ thuật mới"] - D["Tác nhân thay đổi mã"] --> E["Bài kiểm thử + Truth Sync"] - E --> F["Tài liệu luôn cập nhật"] - C --> G["Xem xét trong Git"] - F --> G - H["Tài liệu truth"] --> I["Truth Realize"] - I --> D -``` + + + Cách Truthmark hoạt động + Giao diện dòng lệnh Truthmark cài đặt và xác thực hợp đồng của kho. Tác nhân lập trình của bạn thực hiện việc xem xét bằng chứng và viết tài liệu thông qua các quy trình gốc của host đã được cài đặt. diff --git a/docs/readmes/README.zh.md b/docs/readmes/README.zh.md index 340de7d..b6cd343 100644 --- a/docs/readmes/README.zh.md +++ b/docs/readmes/README.zh.md @@ -88,17 +88,10 @@ truthmark check --base ## Truthmark 的工作原理 -```mermaid -flowchart LR - A["现有代码 + 测试"] --> B["Truth Document"] - B --> C["新的产品与工程文档"] - D["代理更改代码"] --> E["测试 + Truth Sync"] - E --> F["文档保持最新"] - C --> G["Git 审查"] - F --> G - H["事实文档"] --> I["Truth Realize"] - I --> D -``` + + + Truthmark 的工作原理 + Truthmark 命令行界面负责安装并验证仓库契约。您的编码代理通过已安装的宿主原生工作流完成证据审查和文档工作。 diff --git a/package.json b/package.json index 5487acb..62a34ab 100644 --- a/package.json +++ b/package.json @@ -26,6 +26,8 @@ "files": [ "dist", "README.md", + "docs/assets/truthmark-workflow-mobile.svg", + "docs/assets/truthmark-workflow.svg", "docs/readmes/README.ar.md", "docs/readmes/README.de.md", "docs/readmes/README.el.md", diff --git a/tests/package-files.test.ts b/tests/package-files.test.ts index 4adc6da..daf83a6 100644 --- a/tests/package-files.test.ts +++ b/tests/package-files.test.ts @@ -31,6 +31,8 @@ const localizedReadmeFiles = [ const expectedPackageFiles = [ "LICENSE", + "docs/assets/truthmark-workflow-mobile.svg", + "docs/assets/truthmark-workflow.svg", ...localizedReadmeFiles, "README.md", "dist/main.js",