Como usar esta documentação com agentes de IA
Quando um agente de IA de programação (Claude Code, Cursor, GitHub Copilot, Codex…) escreve a sua integração, indique a ele os recursos abaixo. Eles têm o mesmo conteúdo das páginas que você lê, em formatos que um agente baixa e interpreta com facilidade. A última seção traz um parágrafo pronto para colar nas instruções do seu agente.
Comece pelo llms.txt
| Arquivo | O que contém |
|---|---|
| llms.txt | Índice dos produtos em inglês: para cada um, uma descrição de uma linha, os links para o seu llms.txt e o seu texto completo (com os tamanhos) e para a sua referência rápida. Termina com as especificações OpenAPI. |
<produto>/llms.txt, por exemplo en-us/articles/signer/llms.txt | As páginas em inglês de um produto, cada uma com a URL em Markdown e uma descrição de uma linha. A referência rápida vem primeiro. As páginas que ainda não existem em inglês apontam para a versão em português, marcadas com (pt-br). O arquivo fica na pasta das páginas do produto. |
<produto>/llms-full.txt, por exemplo en-us/articles/web-pki/llms-full.txt | As mesmas páginas na íntegra, num só arquivo, cada uma sob um título com a sua URL: a documentação de um produto numa só requisição. |
<produto>/llms-full-1.txt, llms-full-2.txt… | Quando o texto completo de um produto passa de 400 KB, ele vem em partes de no máximo 400 KB, cada uma com páginas consecutivas. O llms.txt do produto lista as partes com os seus tamanhos e as páginas de cada uma, e o seu llms-full.txt também as lista. |
| llms-full.txt | As páginas de todos os produtos num só arquivo. Passa de alguns megabytes, mais do que um agente consegue ler de uma vez: prefira o llms-full.txt do produto. |
pt-br/llms.txt, pt-br/llms-full.txt, articles/<produto>/llms.txt e llms-full.txt | O mesmo para as páginas em português. |
Todos seguem o formato llms.txt.
Cada página em Markdown
Acrescente .md à URL de qualquer página para obtê-la em Markdown puro. Por exemplo,
https://docs.lacunasoftware.com/articles/signer/get-started.md é a versão em Markdown de
https://docs.lacunasoftware.com/articles/signer/get-started.
- O front matter traz o título, a descrição, a URL canônica, o idioma, o produto e a data da última alteração.
- As abas viram um bloco de código por aba, cada um com um rótulo em negrito; observações e avisos viram citações; links e imagens são URLs absolutas.
- Cada página aponta para a sua versão em Markdown no head do HTML (
<link rel="alternate" type="text/markdown">) e abaixo do conteúdo (Ver em Markdown, Copiar página em Markdown). - A referência da API .NET do PKI SDK funciona do mesmo jeito: https://docs.lacunasoftware.com/api/Lacuna.Pki/PKCertificate.md.
Referências rápidas
Uma página por produto com o que uma integração precisa primeiro: instalação, configuração e autenticação,
operações principais com código, erros, certificados de teste, demonstrações e exemplos. O que a documentação
ainda não cobre fica marcado como TODO(docs) em vez de ser deduzido.
Em dúvida sobre qual produto usar? Veja Como escolher um produto.
Especificações das APIs
A especificação OpenAPI de cada API em nuvem é copiada para uma URL estável neste site. As instâncias on-premises
servem a sua própria em /swagger.
Demonstrações e exemplos
- Demonstrações: https://try.lacunasoftware.com/demos.json lista as demonstrações de try.lacunasoftware.com, com o produto, a página da documentação e os exemplos de cada uma.
- Exemplos: os repositórios PkiSuiteSamples e
SignerSamples mantêm cada um um catálogo
samples.json(https://raw.githubusercontent.com/LacunaSoftware/PkiSuiteSamples/master/samples.json e https://raw.githubusercontent.com/LacunaSoftware/SignerSamples/master/samples.json): uma entrada por tarefa e linguagem, com o arquivo a ler, como executá-lo, a página da documentação e a demonstração. - As páginas que tratam de uma tarefa terminam com um quadro Demonstrações e exemplos que aponta para a demonstração e para o exemplo em cada linguagem.
Um parágrafo para o seu agente
Cole isto nas instruções do seu agente (por exemplo CLAUDE.md, AGENTS.md ou .cursor/rules) e diga qual
produto você usa. O texto fica em inglês, o idioma mais completo da documentação:
This project integrates Lacuna Software products (digital certificates, digital signatures, PKI).
Use the official docs at https://docs.lacunasoftware.com and read them as Markdown:
- Start with https://docs.lacunasoftware.com/llms.txt, the index of the products. It links each
product's own llms.txt (its pages) and llms-full.txt (those pages in full, in one file, or in
parts of at most 400 KB for the largest products).
- Add ".md" to any docs page URL to get its Markdown version.
- Read the product's quick reference first (linked from the product in llms.txt): packages,
configuration, core operations, errors and samples.
- For REST APIs, use the OpenAPI specs at https://docs.lacunasoftware.com/openapi/ (listed at the
end of llms.txt).
- For working code, follow the samples linked from the docs pages (PkiSuiteSamples and
SignerSamples on GitHub) in this project's language.
Do not guess package names, versions, endpoints or headers: take them from the quick reference, the
OpenAPI spec or a sample. When developing, use the test certificates from
https://docs.lacunasoftware.com/en-us/articles/pki-guide/test-certs, never production certificates.