Skip to content

Docs: frontmatter de máquina do portal no docs/ - #55

Merged
andrenfe merged 1 commit into
masterfrom
chore/docs-machine-frontmatter
Oct 17, 2026
Merged

andrenfe merged 1 commit into
masterfrom
chore/docs-machine-frontmatter

Conversation

@andrenfe

@andrenfe andrenfe commented Oct 17, 2026 •

Copy link
Copy Markdown
Member

O que é

As páginas de docs/ são espelhadas no portal de documentação.
Lá, o frontmatter de máquina vira faceta de busca da base de conhecimento: tags em três eixos,
integration: [sdk] e status. As tags existiam só do lado do portal, e a última sincronização
precisou de um merge de três vias para não apagá-las.

Este PR copia para cá o frontmatter de máquina do portal, página por página, e registra a regra no
CLAUDE.md. Não publica nada: docs/ não vai no npm.

O que entra

  • integration: [sdk] nas 32 páginas;
  • o documento fiscal (nfse, nfe, nfce, cte) nas páginas que tratam dele;
  • status: deprecated em recursos/consumer-invoice-query.md, sem substituto, e no API.md legado,
    com superseded_by para o índice da biblioteca;
  • no CLAUDE.md, a regra de manter esse frontmatter e de sincronizar por merge de três vias.

Verificação

frontmatter de máquina   idêntico ao do portal nas 32 páginas
corpo das páginas        inalterado
unit                     791 passed | 6 skipped

@github-actions

Copy link
Copy Markdown

📋 OpenAPI Spec Validation

✅ All specs validated and types generated successfully

Specs processed:

  • calculo-impostos-v1.yaml - 27.90 KB, 853 lines
  • consulta-cnpj.yaml - 34.28 KB, 1128 lines
  • consulta-cpf.yaml - 3.39 KB, 83 lines
  • consulta-cte-v2.yaml - 18.33 KB, 578 lines
  • consulta-endereco.yaml - 11.17 KB, 343 lines
  • consulta-nf-consumidor.yaml - 43.41 KB, 1279 lines
  • consulta-nf.yaml - 137.87 KB, 3119 lines
  • consulta-nfe-distribuicao-v1.yaml - 53.07 KB, 1775 lines
  • nf-consumidor-v2.yaml - 293.87 KB, 7609 lines
  • nf-produto-v2.yaml - 309.41 KB, 8204 lines
  • nf-servico-v1.yaml - 257.67 KB, 6255 lines
  • nfeio.yaml - 15.86 KB, 630 lines
  • product-invoice-rtc-v1.yaml - 198.88 KB, 5084 lines
  • service-invoice-rtc-v1.yaml - 95.30 KB, 1728 lines

Generated types available as artifact in src/generated/.

As paginas de docs/ sao espelhadas no portal de documentacao, onde o
frontmatter de maquina vira faceta de busca da base de conhecimento:
tags em tres eixos, integration: [sdk] e status. As tags existiam so do
lado do portal, e a sincronizacao precisou de merge de tres vias para
nao apaga-las.

Copia para ca o frontmatter de maquina do portal, pagina por pagina, e
registra a regra no CLAUDE.md.
@andrenfe
andrenfe force-pushed the chore/docs-machine-frontmatter branch from 9d22df2 to 682f4e4 Compare October 17, 2026 02:01
@github-actions

Copy link
Copy Markdown

📋 OpenAPI Spec Validation

✅ All specs validated and types generated successfully

Specs processed:

  • calculo-impostos-v1.yaml - 27.90 KB, 853 lines
  • consulta-cnpj.yaml - 34.28 KB, 1128 lines
  • consulta-cpf.yaml - 3.39 KB, 83 lines
  • consulta-cte-v2.yaml - 18.33 KB, 578 lines
  • consulta-endereco.yaml - 11.17 KB, 343 lines
  • consulta-nf-consumidor.yaml - 43.41 KB, 1279 lines
  • consulta-nf.yaml - 137.87 KB, 3119 lines
  • consulta-nfe-distribuicao-v1.yaml - 53.07 KB, 1775 lines
  • nf-consumidor-v2.yaml - 293.87 KB, 7609 lines
  • nf-produto-v2.yaml - 309.41 KB, 8204 lines
  • nf-servico-v1.yaml - 257.67 KB, 6255 lines
  • nfeio.yaml - 15.86 KB, 630 lines
  • product-invoice-rtc-v1.yaml - 198.88 KB, 5084 lines
  • service-invoice-rtc-v1.yaml - 95.30 KB, 1728 lines

Generated types available as artifact in src/generated/.

@andrenfe
andrenfe merged commit 0e96450 into master Oct 17, 2026
13 checks passed
@andrenfe
andrenfe deleted the chore/docs-machine-frontmatter branch October 17, 2026 13:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant