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.

@Miracle656 Miracle656 left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apologies for the wait on this one.

Two things to resolve, and one of them I would like explained before anything merges.

Unexplained deletions

This PR deletes two files that are live on main:

docs/cookbook/portfolio.md          (-52)
docs/cookbook/dashboard-preview.jpg (binary)

Neither is mentioned in the description, which is entirely about adding TypeDoc publishing. Removing documentation inside a CI PR is the kind of thing that goes unnoticed in review and is then hard to trace later.

If they are genuinely obsolete, say so and it is fine. If they were caught by a docs/ clean-up while wiring TypeDoc's output directory, they should come back — and the TypeDoc config should be pointed somewhere that does not collide with hand-written docs.

TypeDoc already exists

The description reads "Add typedoc.json" and "Add .github/workflows/typedoc.yml", but both are already on main — the diff is +6/-1 and +18/-7 against existing files, and a TypeDoc workflow already runs green on main. Something landed in the interim.

So this is a refinement of existing config rather than new capability, which is fine — but the description should say what it improves over what is there, because right now a reviewer cannot tell what problem is being fixed.

What would make this mergeable

  1. Restore the two docs/cookbook/ files, or explain why they should go
  2. Update the description to state what changes relative to the existing TypeDoc setup
  3. Confirm the gh-pages publish does not overwrite anything hand-written already served from that branch

Worth noting peaceiris/actions-gh-pages will happily replace the whole branch contents depending on configuration — that is worth double-checking given point 1.

Not closing it. If the cookbook deletion was accidental this is a quick fix; if you would rather drop the PR after the delay, that is fair too.

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