-
Notifications
You must be signed in to change notification settings - Fork 36
Auto-publish TypeDoc to gh-pages #62
Copy link
Copy link
Open
Labels
Stellar WaveIssues in the Stellar wave programIssues in the Stellar wave programarea:ciCI/CD and toolingCI/CD and toolingarea:docsDocumentationDocumentationdifficulty:easy~1-3 hours~1-3 hoursgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed
Description
Metadata
Metadata
Assignees
Labels
Stellar WaveIssues in the Stellar wave programIssues in the Stellar wave programarea:ciCI/CD and toolingCI/CD and toolingarea:docsDocumentationDocumentationdifficulty:easy~1-3 hours~1-3 hoursgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed
Background
Wraith's internal modules are useful as a Node library too, but they're undocumented. TypeDoc can generate a browsable API reference from the existing TSDoc comments with zero new content authoring.
What to build
A workflow that runs
typedocand pushes the HTML output togh-pageson every main push.Key files
typedoc.json.github/workflows/typedoc.ymlSuggested execution
npm i -D typedoctypedoc.jsonwithentryPointscovering the public modulesnpx typedocand pushesdocs/togh-pagesviapeaceiris/actions-gh-pagesExample commit message:
ci(docs): auto-publish TypeDoc API reference to gh-pagesAcceptance criteria