truthmark 2.3.0 → 2.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,220 +1,194 @@
1
1
  # Truthmark
2
2
 
3
- **Seus agentes escrevem código. O Truthmark mantém documentação voltada para humanos e revisável no Git.**
3
+ **Seus agentes escrevem código. O Truthmark mantém a documentação voltada para pessoas e revisável no Git.**
4
4
 
5
- [🇺🇸 English](../../README.md) | [🇨🇳 简体中文](README.zh.md) | [🇯🇵 日本語](README.ja.md) | [🇰🇷 한국어](README.ko.md) | [🇩🇪 Deutsch](README.de.md) | [🇫🇷 Français](README.fr.md) | [🇪🇸 Español](README.es.md) | [🇧🇷 Português](README.pt.md) | [🇷🇺 Русский](README.ru.md) | [🇸🇦 العربية](README.ar.md) | [🇮🇹 Italiano](README.it.md) | [🇵🇱 Polski](README.pl.md) | [🇹🇷 Türkçe](README.tr.md) | [🇻🇳 Tiếng Việt](README.vi.md) | [🇮🇩 Bahasa Indonesia](README.id.md) | [🇬🇷 Ελληνικά](README.el.md)
5
+ O Truthmark instala fluxos de trabalho nativos do Git que permitem que agentes de programação com IA criem nova documentação de produto e engenharia a partir de código e testes existentes, mantenham-na atualizada após cada mudança de código e entreguem diffs comuns de Markdown para sua revisão.
6
6
 
7
- ![Banner do Truthmark](../assets/truthmark-banner.png)
7
+ [![versão no npm](https://img.shields.io/npm/v/truthmark?color=cb3837&label=npm)](https://www.npmjs.com/package/truthmark)
8
+ [![CI](https://github.com/merlinhu1/truthmark/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/merlinhu1/truthmark/actions/workflows/ci.yml)
9
+ [![Licença: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](../../LICENSE)
10
+ [![Node.js >=24](https://img.shields.io/badge/node-%3E%3D24-339933?logo=node.js&logoColor=white)](../../package.json)
8
11
 
9
- ## 🚀 Início rápido: rodando localmente em cinco minutos
12
+ [Comece agora](#início-rápido-crie-seu-primeiro-documento-de-verdade) · [Site](https://merlinhu1.github.io/truthmark/) · [Guia do usuário](https://github.com/merlinhu1/truthmark/blob/main/docs/user-guide.md) · [GitHub](https://github.com/merlinhu1/truthmark)
10
13
 
11
- Execute isto dentro do repositório Git que você quer que o Truthmark gerencie:
14
+ <details>
15
+ <summary>Leia este README em 16 idiomas</summary>
12
16
 
13
- ```bash
14
- cd /path/to/your-repo
15
- npm install -g truthmark
16
- truthmark init
17
- truthmark check
18
- git diff
19
- ```
17
+ [🇺🇸 English](../../README.md) | [🇨🇳 简体中文](README.zh.md) | [🇯🇵 日本語](README.ja.md) | [🇰🇷 한국어](README.ko.md) | [🇩🇪 Deutsch](README.de.md) | [🇫🇷 Français](README.fr.md) | [🇪🇸 Español](README.es.md) | [🇧🇷 Português](README.pt.md) | [🇷🇺 Русский](README.ru.md) | [🇸🇦 العربية](README.ar.md) | [🇮🇹 Italiano](README.it.md) | [🇵🇱 Polski](README.pl.md) | [🇹🇷 Türkçe](README.tr.md) | [🇻🇳 Tiếng Việt](README.vi.md) | [🇮🇩 Bahasa Indonesia](README.id.md) | [🇬🇷 Ελληνικά](README.el.md)
20
18
 
21
- Em um terminal interativo, `truthmark init` mostra uma seleção múltipla numerada. Escolha zero ou mais plataformas, ou `none` para uma configuração neutra em relação a host e somente de CLI.
19
+ </details>
22
20
 
23
- Para scripts e CI, repita `--platform`; `--json` nunca exibe uma solicitação interativa:
21
+ ## Crie os primeiros documentos. Mantenha-os verdadeiros.
24
22
 
25
- ```bash
26
- truthmark init --platform codex --platform cursor
27
- truthmark init --json
28
- ```
23
+ A maioria das ferramentas de documentação para depois da geração. O Truthmark oferece aos agentes um ciclo de vida completo da documentação dentro do seu repositório:
29
24
 
30
- Na primeira execução não interativa sem `--platform`, a configuração permanece neutra; execuções posteriores mantêm a seleção salva em `.truthmark/config.yml`.
25
+ - **Crie novos documentos a partir de software funcional.** O Truth Document código e testes e, em seguida, cria documentação delimitada de produto ou engenharia.
26
+ - **Mantenha os documentos alinhados automaticamente.** O Truth Sync é executado na entrega do agente após mudanças funcionais no código e atualiza a verdade do repositório antes que o trabalho seja concluído.
27
+ - **Transforme documentos de volta em código.** O Truth Realize implementa documentos de verdade aprovados e preserva um fluxo de trabalho limpo que começa pela documentação.
28
+ - **Repare a propriedade conforme a base de código cresce.** O Truth Structure cria rotas delimitadas e documentos iniciais para áreas novas ou sobrecarregadas.
29
+ - **Revise tudo no Git.** Código, decisões, contratos, arquitetura, operações e comportamento viajam juntos com a branch.
31
30
 
32
- Agora experimente o caminho de adoção mais comum: documentar, a partir do código e dos testes, um comportamento existente. No seu host de codificação com IA, peça ao workflow instalado:
31
+ Sem base de conhecimento hospedada. Sem memória privada de agentes. Sem documentação presa no histórico de chats.
33
32
 
34
- ```text
35
- /truthmark-document document the implemented session timeout behavior across src/auth/session.ts and tests/auth/session.test.ts
36
- ```
33
+ ## Início rápido: crie seu primeiro documento de verdade
37
34
 
38
- Depois disso, usuários normalmente não devem invocar o Truth Sync diretamente. Continue codificando por meio do seu host de IA; as instruções instaladas no repositório dizem ao agente para executar os testes relevantes e realizar a revisão Truth Sync antes da entrega quando houver mudanças em código funcional. Você revisa o diff de código resultante junto com o diff dos documentos de verdade.
35
+ **Requisitos:** Node.js 24 ou mais recente, um repositório Git e um host de programação com IA compatível com fluxos de trabalho de agentes.
39
36
 
40
- Se você quer apenas validação por CLI, escolha `none` e continue com `truthmark check`; depois você pode executar `truthmark init` novamente para selecionar plataformas.
37
+ Execute isto dentro do repositório que você quer que o Truthmark gerencie:
41
38
 
42
- ## 💡 O problema: a lacuna de documentação da IA
39
+ ```bash
40
+ cd /path/to/your-repo
41
+ npm install -g truthmark
42
+ truthmark init
43
+ ```
43
44
 
44
- Agentes de codificação com IA são incríveis para escrever código rapidamente. Mas essa velocidade cria um novo modo de falha perigoso: **a história do repositório se afasta da realidade.**
45
+ `truthmark init` permite selecionar Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity, Cursor ou uma configuração de interface de linha de comando neutra em relação ao host.
45
46
 
46
- * Comportamentos se perdem em históricos de chat efêmeros.
47
- * Documentos de arquitetura ficam desatualizados rapidamente.
48
- * Decisões de produto desaparecem após a entrega.
49
- * Revisores de código acabam examinando diffs de código crus sem entender o “porquê”.
50
- * Cada nova sessão de IA é forçada a redescobrir do zero a verdade do seu repositório.
47
+ Agora peça ao agente configurado que documente um comportamento real:
51
48
 
52
- ## 🎯 A solução: Truthmark
49
+ ```text
50
+ /truthmark-document document the implemented session timeout behavior across src/auth/session.ts and tests/auth/session.test.ts
51
+ ```
53
52
 
54
- **Truthmark** instala no seu repositório uma camada de workflow nativa do Git. Ele corrige a parte do desenvolvimento com IA que geralmente quebra: ajudar a documentação a permanecer alinhada com o código.
53
+ O Truth Document cria um novo documento de verdade delimitado quando nenhum existe, atualiza o proprietário existente quando ele existe e atualiza o roteamento quando necessário. Ele não altera o código funcional.
55
54
 
56
- Em vez de esperar que humanos e agentes de IA se lembrem de atualizar a documentação, o Truthmark transforma a documentação em um hábito sistemático e revisável dentro do próprio repositório.
55
+ Revise o resultado:
57
56
 
58
- ### ✨ Por que o Truthmark é único
57
+ ```bash
58
+ truthmark check
59
+ git status --short --untracked-files=all
60
+ git diff
61
+ ```
59
62
 
60
- Truthmark não é apenas mais uma ferramenta de documentação. Ele é profundamente integrado ao workflow de IA:
63
+ Agora você deve ter:
61
64
 
62
- * **🚫 Sem dependência de fornecedor:** nenhum serviço hospedado, nenhum banco de dados oculto, nenhum servidor extra para operar.
63
- * **🌳 100% nativo do Git:** tudo vive no seu repositório. A verdade se move com a sua branch.
64
- * **🤝 Contrato pertencente a humanos e seguido por agentes:** Mantenedores possuem o contrato do repositório; agentes seguem as instruções instaladas enquanto programam.
65
- * **✅ Confiança por verificação:** o trabalho da IA fica mais fácil de confiar porque trabalhos que mudam comportamento incluem uma decisão ou diff de documento de verdade revisável por humanos.
65
+ ```text
66
+ docs/truthmark/engineering/behaviors/session-timeout.md
67
+ docs/truthmark/routes/areas/authentication.md
68
+ ```
66
69
 
67
- ## 🔄 Como funciona
70
+ Os caminhos exatos seguem a estrutura de propriedade do seu repositório. Novos arquivos aparecem em `git status`; mudanças em arquivos rastreados aparecem em `git diff`.
68
71
 
69
- Quando um agente de IA modifica seu código, o trabalho não está terminado. O Truthmark instala uma proteção de workflow no fim da tarefa que os agentes seguem antes da entrega:
72
+ A forma de invocação varia conforme o host. O OpenCode usa `/skill truthmark-document`, o Antigravity usa `@truthmark-document` e os outros hosts compatíveis usam sua superfície nativa de skills ou comandos com barra. Consulte a [tabela de plataformas](https://github.com/merlinhu1/truthmark/blob/main/docs/user-guide.md#supported-agent-platforms) para ver os comandos exatos.
70
73
 
71
- 1. 💻 **Código:** o agente modifica código funcional.
72
- 2. 🧪 **Teste:** testes relevantes são executados.
73
- 3. 🔍 **Verificar:** Truthmark verifica a documentação mapeada como parte da revisão de encerramento instalada.
74
- 4. 📝 **Documentação:** os docs são atualizados pelo agente quando a verdade do repositório mudou.
75
- 5. 👀 **Revisão:** uma pessoa revisa o *diff de código* + o *diff de verdade*.
74
+ Para scripts e integração contínua, informe explicitamente as plataformas selecionadas:
76
75
 
77
- ## 🛠 Como você interage com o Truthmark
76
+ ```bash
77
+ truthmark init --platform codex --platform cursor
78
+ truthmark init --json
79
+ ```
78
80
 
79
- Truthmark tem um contrato local do repositório e duas formas de usá-lo.
81
+ Escolha `none` interativamente ou execute `truthmark init --clear-platforms` para ter um repositório neutro em relação ao host. Você pode adicionar plataformas de agentes mais tarde executando `truthmark init` novamente.
80
82
 
81
- ### Pessoas instalam e validam o contrato
83
+ Para diagnósticos de atualidade relativos à branch, informe uma base do Git:
82
84
 
83
- Mantenedores e CI usam a CLI:
85
+ ```bash
86
+ truthmark check --base <base-ref>
87
+ ```
84
88
 
85
- * `truthmark init` - cria ou atualiza a configuração, permite escolher zero ou mais plataformas e instala roteamento, scaffolds de documentos de verdade e instruções dos hosts selecionados.
86
- * `truthmark check` - valida a verdade do repositório pelo terminal.
89
+ ## Como o Truthmark funciona
87
90
 
88
- ### Agentes seguem o contrato enquanto programam
91
+ <picture>
92
+ <source media="(max-width: 700px)" srcset="../assets/truthmark-workflow-mobile.svg">
93
+ <img src="../assets/truthmark-workflow.svg" alt="Como o Truthmark funciona" width="1440">
94
+ </picture>
89
95
 
90
- Truthmark instala instruções locais do repositório para hosts de codificação com IA compatíveis, como Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity e Cursor.
96
+ 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.
91
97
 
92
- O ciclo normal é simples:
98
+ Uma mudança normal de código segue um ciclo simples:
93
99
 
94
- 1. Peça ao seu agente uma mudança de código ou que documente um comportamento existente.
95
- 2. As instruções instaladas dizem ao agente quando testar, quando atualizar documentos de verdade e quando parar para revisão humana.
96
- 3. Você revisa diffs Git comuns: código mais quaisquer mudanças em documentos de verdade.
100
+ 1. O agente altera o código funcional.
101
+ 2. Os testes relevantes são executados.
102
+ 3. O Truth Sync verifica a documentação mapeada.
103
+ 4. O agente cria ou atualiza documentos e roteamento quando a verdade do repositório muda.
104
+ 5. Você revisa o diff de código e o diff de verdade juntos.
97
105
 
98
- As solicitações de agente iniciadas pelo usuário são intencionalmente poucas:
106
+ ## Fluxos de trabalho
99
107
 
100
- * `/truthmark-document` - documenta comportamento implementado existente a partir de código e testes.
101
- * `/truthmark-realize` - implementa código a partir de documentos de verdade existentes.
102
- * `/truthmark-check` - audita a verdade do repositório.
108
+ | Fluxo de trabalho | Quando usar | Resultado |
109
+ | -------------------- | --------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
110
+ | **Truth Document** | O código existente precisa de documentação | Cria ou atualiza documentação de produto e engenharia respaldada por evidências |
111
+ | **Truth Sync** | O código funcional mudou | Mantém os documentos mapeados e o roteamento alinhados antes da entrega |
112
+ | **Truth Structure** | Uma área nova precisa de propriedade ou os documentos existentes são abrangentes demais | Cria rotas delimitadas e documentos iniciais básicos |
113
+ | **Truth Realize** | Um documento de verdade aprovado deve se tornar software funcional | Atualiza o código funcional a partir da documentação |
114
+ | **Truth Check** | A verdade do repositório precisa de uma auditoria | Relata problemas de roteamento, propriedade, evidências e documentação |
115
+ | **Truthmark Portal** | A equipe quer um site de documentação navegável | Gera uma apresentação HTML estática e versionada a partir de documentos de verdade em Markdown |
103
116
 
104
- Truth Sync não é o modo usual de começar trabalho; é a revisão de encerramento após mudanças funcionais de código.
105
- Truth Structure não é um comando cotidiano; ele repara roteamento ou propriedade somente quando isso bloqueia o trabalho.
117
+ O Truthmark instala esses fluxos de trabalho como superfícies nativas do repositório para Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity e Cursor.
106
118
 
107
119
  ## O que você recebe
108
120
 
109
- | Capacidade | O que faz |
110
- | --- | --- |
111
- | Verdade nativa do Git | Mantém a verdade do repositório em Markdown e configuração commitados. |
112
- | Documentação com escopo de branch | A verdade se move com a branch em vez de viver em uma sessão privada. |
113
- | CLI humana | Dá aos mantenedores comandos de configuração, atualização, validação e inspeção. |
114
- | Orientação de agente instalada | Diz aos agentes de codificação quando documentar, testar, sincronizar verdade, auditar ou parar para revisão. |
115
- | Roteamento explícito | Mapeia áreas de código para documentos de verdade canônicos. |
116
- | Entregas revisáveis | Produz diffs Git comuns tanto para código quanto para documentos de verdade. |
117
- | Operação local-first | Não requer serviço hospedado, daemon, banco de dados nem servidor MCP. |
118
- | Limites de escrita mais seguros | Separa workflows code-first, doc-first, read-only e doc-only. |
119
- | Validação | Relata problemas de roteamento, autoridade, frontmatter, links, superfícies geradas, escopo de branch, frescor e cobertura. |
120
- | Portal opcional | Gera, quando explicitamente ativado e solicitado, um site estático HTML commitado a partir de documentos de verdade em Markdown. |
121
-
122
- ## Visão geral visual
123
-
124
- ![Recursos do Truthmark](../assets/truthmark-features.png)
125
-
126
- **Recursos:** o que o Truthmark instala e como a superfície de workflow é dividida.
121
+ ### Documentação que parte da realidade
127
122
 
128
- ![Posição do Truthmark](../assets/truthmark-position.png)
123
+ O Truthmark pode criar documentação de recursos do produto, comportamento da implementação, interfaces de programação de aplicações, arquitetura, fluxos de trabalho, operações e testes. Código e testes fornecem as evidências; documentos Markdown delimitados preservam o resultado.
129
124
 
130
- **Posição:** onde o Truthmark se encaixa em relação a prompts, memória e workflows de especificação.
125
+ ### Documentação que resiste à próxima mudança
131
126
 
132
- ![Fluxo de sincronização do Truthmark](../assets/truthmark-syncflow.png)
127
+ As rotas conectam áreas de código a documentos canônicos. Quando agentes alteram o comportamento, o Truth Sync sabe onde a verdade correspondente deve ficar e mantém a entrega pronta para revisão.
133
128
 
134
- **Fluxo de sincronização:** como o Truth Sync conclui mudanças normais de código antes da entrega.
129
+ ### Verdade de produto e engenharia em faixas separadas
135
130
 
136
- ## Por que equipes o adotam
131
+ A verdade de produto registra promessas voltadas ao usuário, limites, decisões e critérios de aceitação. A verdade de engenharia registra o comportamento atual, contratos, arquitetura, fluxos de trabalho, operações e comportamento dos testes.
137
132
 
138
- Truthmark é para equipes que já sabem que agentes de IA podem gerar código.
133
+ ### Colaboração nativa do Git
139
134
 
140
- O próximo problema é governança.
135
+ Tudo que importa vive em arquivos versionados do repositório. A verdade acompanha a branch, funciona com pull requests comuns e permanece visível para cada mantenedor e agente de programação.
141
136
 
142
- Não governança como cerimônia. Governança como uma pergunta simples:
137
+ ### Operação local-first
143
138
 
144
- > Depois desta mudança assistida por IA, o repositório ainda diz a verdade?
145
-
146
- Truthmark ajuda equipes a responder isso com arquivos commitados, roteamento explícito e diffs revisáveis.
147
-
148
- Ele é útil quando você precisa de:
149
-
150
- - menos desvio de documentação
151
- - melhores entregas
152
- - verdade de produto específica por branch
153
- - documentação duradoura de arquitetura e API
154
- - ownership explícito entre docs e código
155
- - limites de escrita de agentes mais seguros
156
- - documentação revisável em vez de memória oculta
157
- - orientação de agente que ainda funciona a partir de arquivos commitados no repositório
139
+ O Truthmark não precisa de serviço hospedado, daemon, banco de dados, banco vetorial ou servidor do Model Context Protocol. O repositório carrega seu próprio fluxo de trabalho de documentação.
158
140
 
159
141
  ## Onde o Truthmark se encaixa
160
142
 
161
- Truthmark não substitui prompts, memória, specs, testes nem revisão de código.
162
-
163
- Ele a esses workflows um lugar durável para pousar no Git.
164
-
165
- | Necessidade | Melhor encaixe |
166
- | --- | --- |
167
- | Melhor saída de uma sessão de agente | Prompt melhor |
168
- | Continuidade pessoal ou no nível da sessão | Ferramenta de memória |
169
- | Trabalho de funcionalidade com plano primeiro | Workflow de especificação |
170
- | Verdade com escopo de branch que viaja com o código | Truthmark |
171
- | Validar correção de comportamento | Testes e revisão |
172
- | Revisar mudanças de documentação assistidas por IA | Truthmark mais revisão Git |
173
-
174
- A faixa de atuação do Truthmark é estreita por design:
143
+ | Necessidade | Melhor opção |
144
+ | ------------------------------------------------------- | ------------------------------------- |
145
+ | Melhor resultado de uma sessão de agente | Um prompt melhor |
146
+ | Continuidade pessoal ou no nível da sessão | Uma ferramenta de memória |
147
+ | Desenvolvimento de recursos que começa por um plano | Um fluxo de trabalho de especificação |
148
+ | Documentação no escopo da branch que viaja com o código | **Truthmark** |
149
+ | Correção do comportamento | Testes e revisão de código |
150
+ | Documentação assistida por IA e revisável | **Truthmark + revisão no Git** |
175
151
 
176
- ```text
177
- make repository truth explicit
178
- route it to code
179
- instalar orientação de agente ao redor dela
180
- keep the result reviewable in Git
181
- ```
182
-
183
- ## Aprofunde-se
152
+ O Truthmark foi criado para mantenedores e equipes de engenharia que já usam agentes de programação com IA e querem que o repositório continue dizendo a verdade na mesma velocidade em que o código muda.
184
153
 
185
- O README é a vitrine: contexto rápido, início rápido e o modelo mental central.
154
+ ## Hosts compatíveis e linha de comando
186
155
 
187
- Para uso comando por comando, comparações de superfícies, detalhes de plataformas compatíveis, configuração, roteamento, Portal e exemplos, leia o [guia do usuário do Truthmark](../user-guide.md).
156
+ Hosts de agentes compatíveis:
188
157
 
189
- ## Status do projeto
158
+ - Codex
159
+ - Claude Code
160
+ - GitHub Copilot
161
+ - OpenCode
162
+ - Antigravity
163
+ - Cursor
190
164
 
191
- A versão atual fornece:
165
+ <details>
166
+ <summary>Referência da linha de comando</summary>
192
167
 
193
- - comandos CLI locais para init, check, index, impact e status de workflows
194
- - instruções de agente locais do repositório geradas para Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity e Cursor
195
- - diagnósticos de roteamento, autoridade, frontmatter, links, frescor, superfícies geradas, escopo de branch e cobertura
196
- - documentos de verdade com escopo de branch e artefatos derivados de inteligência do repositório
168
+ | Comando | Finalidade |
169
+ | ----------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
170
+ | `truthmark init` | Cria ou atualiza a configuração, o roteamento, os templates e os fluxos de trabalho dos hosts selecionados |
171
+ | `truthmark check [--base <ref>]` | Valida a verdade do repositório e, opcionalmente, executa diagnósticos de atualidade da branch |
172
+ | `truthmark index --json` | Inspeciona metadados derivados do repositório e do roteamento |
173
+ | `truthmark impact --base <ref> --json` | Mapeia arquivos alterados para documentos, proprietários e testes próximos |
174
+ | `truthmark workflow status --workflow <id> [--base <ref>] --json` | Inspeciona a aplicabilidade e os alvos do fluxo de trabalho |
175
+ | `truthmark validate ...` | Valida relatórios de fluxos de trabalho e concessões de escrita |
176
+ | `truthmark uninstall --dry-run` / `truthmark uninstall --apply` | Visualiza ou remove superfícies de host geradas, preservando a verdade criada |
197
177
 
198
- ## Documentação
178
+ A saída JSON estruturada está disponível em toda a interface de linha de comando para scripts e integração contínua.
199
179
 
200
- - [Guia do usuário](../user-guide.md)
201
- - [Índice de docs](../README.md)
202
- - [Visão geral da arquitetura](../truthmark/engineering/architecture/overview.md)
203
- - [Contratos de API e CLI](../truthmark/engineering/contracts/config-route-and-check-contracts.md)
204
- - [Guia de manutenção da verdade do repositório](../standards/maintaining-repository-truth.md)
180
+ </details>
205
181
 
206
- Para comandos de desenvolvimento local e contribuição, consulte [CONTRIBUTING.md](../../CONTRIBUTING.md).
182
+ ## Saiba mais
207
183
 
208
- ## Limites de design
184
+ - [Guia do usuário do Truthmark](https://github.com/merlinhu1/truthmark/blob/main/docs/user-guide.md)
185
+ - [Índice da documentação](https://github.com/merlinhu1/truthmark/blob/main/docs/README.md)
186
+ - [Visão geral da arquitetura](https://github.com/merlinhu1/truthmark/blob/main/docs/truthmark/engineering/architecture/overview.md)
187
+ - [Contratos de configuração, roteamento e comandos](https://github.com/merlinhu1/truthmark/blob/main/docs/truthmark/engineering/contracts/config-route-and-check-contracts.md)
188
+ - [Como contribuir](https://github.com/merlinhu1/truthmark/blob/main/CONTRIBUTING.md)
209
189
 
210
- Truthmark é intencionalmente pequeno: local, commitado, com escopo de branch e revisável.
211
-
212
- Ele não é um serviço hospedado, servidor MCP, banco de dados vetorial, camada de memória oculta, produto de enforcement de CI nem motor autônomo de reescrita de código. Ele ajuda a verdade do repositório a permanecer visível; não substitui testes, revisão de código nem julgamento humano.
190
+ **Instale o Truthmark, selecione seu host de programação e transforme hoje um comportamento real em documentação.**
213
191
 
214
192
  ## Licença
215
193
 
216
- MIT. Veja [LICENSE](../../LICENSE).
217
-
218
- ## Remoção segura
219
-
220
- Use `truthmark uninstall --dry-run` para revisar as superfícies de host geradas com precisão, e depois `truthmark uninstall --apply` para removê-las. Truth criada, configuração, templates, saída do Portal, arquivos Gemini e arquivos de usuário não relacionados são preservados; remova uma instalação global de npm separadamente com seu gerenciador de pacotes.
194
+ MIT. Consulte [LICENSE](../../LICENSE).