ci(docs): auto-publish TypeDoc API reference to gh-pages - #158
Conversation
- 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
|
The TypeDoc workflow cleanup here is good (npm ci, gh-pages@v4,
Scope it to just the TypeDoc CI change and I'll merge. |
Miracle656
left a comment
There was a problem hiding this comment.
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
- Restore the two
docs/cookbook/files, or explain why they should go - Update the description to state what changes relative to the existing TypeDoc setup
- 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.
Closes #62