Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.refy.to/llms.txt

Use this file to discover all available pages before exploring further.

Backstage e TechDocs

O Refy agora separa duas camadas:

Pública

Mintlify para:
  • portal de documentacao
  • navegacao de produto e API
  • referencia gerada por OpenAPI
Arquivos públicos centrais:
  • docs.json
  • *.mdx e as pastas de documentacao do Mintlify na raiz do repositorio
  • openapi/refy-rest.yaml

Interna

Backstage para:
  • catálogo de software
  • TechDocs
  • ownership
  • descoberta interna de APIs
Arquivos centrais:
  • catalog-info.yaml
  • mkdocs.yml
  • docs/

Regra prática

Não misture o app do produto com o portal público de documentação. O produto continua no app web. O portal público de docs vive no Mintlify.

Resultado esperado

Essa separação evita três erros:
  • documentação competindo com a UI do produto
  • contrato técnico espalhado
  • catálogo interno e portal público divergindo sem necessidade