Skip to content

Generate and publish JSDoc in gh-pages #165

@viccuad

Description

@viccuad

Developers benefit from having a browsable documentation for the functionality of the sdk. Provide developer docs.

Acceptance criteria

  • Add a new make target to build the JSDoc into an html or markdown page that can be server statically. This can be done with something like https://www.npmjs.com/package/jsdoc-to-markdown.
  • In the release job, before creating the GH release, call the new make target to generate the html page. Push it to the gh-pages branch of the repository, to be browsable.
  • Add a link on the readme to the gh-pages.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions