Skip to content

[Docs/Tipos] TSDoc completo e TypeDoc por categorias #53

@lucianoedipo

Description

@lucianoedipo

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

No one assigned

    Labels

    area: buildBuild, exports, compat Reactarea: docsDocumentação e receitasdocumentationImprovements or additions to documentationenhancementNew feature or requestpriority: mediumPrioridade média

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions