Pular para o conteúdo principal

Como contribuir com a documentação

Adicionar uma library

Siga a estrutura usada pelo SDBalanca:

docs/library/
├── visao-geral.md
└── <nome>/
├── visao-geral.md
├── arquitetura.md
├── api.md
└── exemplos/
└── ...
  1. Crie a pasta em docs/library/<nome>/.
  2. Inclua pelo menos Visão Geral, Arquitetura e API.
  3. Adicione exemplos em exemplos/ quando houver cenários de uso.
  4. Registre as páginas em sidebars.ts (sidebar librarySidebar).
  5. Atualize a tabela em Visão geral — Library e em Estrutura do workspace.

Comandos úteis

npm start
npm run build
npm run serve
npm run typecheck