-
Notifications
You must be signed in to change notification settings - Fork 6
Open
Labels
area/GsoCarea/documentationImprovements or additions to documentationImprovements or additions to documentationgood first issuekind/automation
Description
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-pagesbranch of the repository, to be browsable. - Add a link on the readme to the gh-pages.
Metadata
Metadata
Assignees
Labels
area/GsoCarea/documentationImprovements or additions to documentationImprovements or additions to documentationgood first issuekind/automation