Skip to content

ci(docs): auto-publish TypeDoc API reference to gh-pages - #158

Open
bashir1738 wants to merge 1 commit into
Miracle656:mainfrom
bashir1738:ci/typedoc-publish
Open

ci(docs): auto-publish TypeDoc API reference to gh-pages#158
bashir1738 wants to merge 1 commit into
Miracle656:mainfrom
bashir1738:ci/typedoc-publish

Conversation

@bashir1738

Copy link
Copy Markdown
Contributor
  • Add typedoc.json with entryPoints covering public modules
  • Add .github/workflows/typedoc.yml to run on every main push
  • Push generated HTML output to gh-pages via peaceiris/actions-gh-pages
  • Add README link to hosted docs URL

Closes #62

- Add typedoc.json with entryPoints covering public modules
- Add .github/workflows/typedoc.yml to run on every main push
- Push generated HTML output to gh-pages via peaceiris/actions-gh-pages
- Add README link to hosted docs URL

Closes Miracle656#62
@Miracle656

Copy link
Copy Markdown
Owner

The TypeDoc workflow cleanup here is good (npm ci, gh-pages@v4, keep_files). Two things to trim before it lands:

  1. It deletes docs/cookbook/portfolio.md and dashboard-preview.jpg, but the example they document (examples/portfolio-dashboard) is still in the repo — so this removes live docs. Please drop those deletions unless the example is also going away.
  2. It removes the npm run docs:openapi step from the workflow. If the OpenAPI reference should still be published, keep that step (or explain why it's no longer needed).

Scope it to just the TypeDoc CI change and I'll merge.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Auto-publish TypeDoc to gh-pages

2 participants