Skip to content

Generate documentation from existing jsdoc annotations #1292

Description

@cbutcosk

There are jsdoc annotations throughout the quire codebase that are currently not published anywhere. Merged with the YAML surveys of thegetty/quire-docs#802 it would probably make a decent form of developer-centric API documentation.

There are a few complications to consider (mostly just jsdoc care and feeding):

  • excludePattern from the CLI's jsdoc configuration would need adjusted as the default pattern excludes path components starting with "_".
  • Small adjustments to annotation formats, which are not all formatted correctly and break the documentation build.
  • Some additional jsdoc configuration is needed to render directory-level README.md files as the readme for a tier of documentation and produce an overall table of contents.
  • Some level of indexing (even if just to the directory tiers with README.md files?) would be nice.
  • Other user-level or output format considerations, including deployment of the resulting documentation (as a directory in the docs site?)

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    dev supportIssue related to improving the developer experience at all levels of technical expertise

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions