TriadicFrameworks
Visão geral

Adicionar RTT ao Seu Repositório GitHub

Uma maneira mínima e sem infraestrutura de tornar sua documentação pronta para IA#

RTT fornece uma camada de metadados pequena que torna qualquer repositório do GitHub:

  • mais fácil para ferramentas de IA entenderem
  • mais fácil para motores de documentação (como Docsbook.io) renderizarem
  • mais estruturado, mais navegável e mais autoexplicativo
  • agente sem exigir servidores, APIs ou hospedagem

Este guia mostra como adicionar RTT ao seu repositório em menos de 60 segundos.

1. Crie um arquivo module.json#

Dentro da sua pasta de documentação (ou qualquer pasta de módulo), adicione:

module.json

Exemplo de diretório:

/docs
  /my-module
    README.md
    module.json

2. Adicione este metadado mínimo#

Cole isso em module.json:

{
  "module": "My Module",
  "version": "1.0",
  "description": "Short description of what this module provides.",
  "roles": ["profile", "map"],
  "operators": ["substrate", "flow", "field"],
  "files": {
    "README.md": "profile"
  }
}

Este é o menor bloco de metadados RTT válido.

3. Vincule seus metadados a partir do seu README#

Adicione esta linha no topo (ou na parte inferior) do README.md do seu módulo:

<link rel="rtt-module"
      href="https://raw.githubusercontent.com/<user>/<repo>/main/<path>/module.json">

Substitua <user>, <repo> e <path> pelos detalhes do seu repositório.

Esta é a superfície de ativação.
Ela informa às ferramentas de IA e aos renderizadores de documentação onde seus metadados estão.

4. Use caminhos absolutos para metadados#

Seu link module.json deve usar uma URL absoluta:

https://raw.githubusercontent.com/<user>/<repo>/main/docs/my-module/module.json

Isso garante:

  • agentes de IA podem carregar seus metadados
  • Docsbook.io pode resolvê-los
  • GitHub Pages pode resolvê-los
  • espelhos e forks ainda funcionam

5. Use caminhos relativos para tudo o mais#

Dentro da sua documentação:

  • links para outras páginas
  • exemplos
  • diagramas
  • mapas
  • referências

…devem permanecer relativos.

Isso mantém seu repositório portátil em:

  • GitHub
  • GitHub Pages
  • Docsbook.io
  • espelhos offline
  • futuros renderizadores

6. É isso — seu repositório agora está habilitado para RTT#

Você agora tem:

  • uma identidade de módulo legível por máquina
  • um contrato de metadados portátil
  • uma estrutura independente de renderizador
  • uma camada agente sem infraestrutura
  • documentação amigável para IA

Sem servidores.
Sem APIs.
Sem backend.
Apenas metadados.

7. Opcional: Expanda seus metadados#

Você pode adicionar mais estrutura depois:

  • analyzer_layer
  • lineage
  • regime
  • crosslinks
  • signature
  • diagnostic

Mas a versão mínima acima é suficiente para ativar o RTT.

8. Exemplo: Um módulo mínimo completo#

Diretório#

/docs/tutorial/
    README.md
    module.json

README.md#

<link rel="rtt-module"
      href="https://raw.githubusercontent.com/example/repo/main/docs/tutorial/module.json">

module.json#

{
  "module": "Tutorial",
  "version": "1.0",
  "description": "A simple example module.",
  "roles": ["profile"],
  "operators": ["substrate", "flow"],
  "files": {
    "README.md": "profile"
  }
}

9. Por que os desenvolvedores usam RTT#

Porque isso lhes dá:

  • estrutura
  • descobribilidade
  • legibilidade por IA
  • estabilidade entre renderizadores
  • zero desvio
  • zero sobrecarga

É o menor passo possível que faz um repositório parecer um verdadeiro sistema de documentação.

Desenvolvido por Docsbook