-
Notifications
You must be signed in to change notification settings - Fork 1
Open
Labels
area: buildBuild, exports, compat ReactBuild, exports, compat Reactarea: docsDocumentação e receitasDocumentação e receitasdocumentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestpriority: mediumPrioridade médiaPrioridade média
Description
Resumo da solicitação:
Anotar tipos públicos com @category, @example e gerar TypeDoc organizado por Components/Hooks/Context/Utils/Types.
Caso de uso / problema que resolve:
Melhora DX no editor e navegação na documentação, reduzindo dúvidas de uso.
Solução proposta (esboço):
- Padronizar TSDoc nos exports públicos (src/index.ts).
- Geração de docs com categorias e exemplos mínimos.
Breaking change?
No
Critérios de aceitação:
- Docs em docs/ com categorias e exemplos.
- CI gera docs sem warnings de TSDoc.
Alternativas consideradas:
Docs dispersas no README não escalam.
Links / referências:
typedoc.json, API.md
Metadata
Metadata
Assignees
Labels
area: buildBuild, exports, compat ReactBuild, exports, compat Reactarea: docsDocumentação e receitasDocumentação e receitasdocumentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestpriority: mediumPrioridade médiaPrioridade média