Repository navigation
docs: publish split HTML manual with GitHub Pages - #10
Conversation
mkhellat
left a comment
There was a problem hiding this comment.
Reviewed by building the workflow end-to-end in an isolated checkout of this branch (68c43db). Thanks — the approach is sound and the security scoping is correct, but there's one blocking defect that stops it from ever publishing.
Blocker — output directory name mismatch (Prepare site step fails).
make html with --split=node produces docs/codebud.html/ (dot). The build step correctly asserts test -f docs/codebud.html/index.html, but the next step copies from docs/codebud_html/ (underscore):
cp -a docs/codebud_html/. site/
Run verbatim, this fails with cp: cannot stat 'docs/codebud_html/.': No such file or directory, the step aborts (run: uses bash -e), and site/index.html is never created — so on main the artifact upload and Pages deploy never happen. The repo's own .gitignore (line 34) tracks docs/codebud.html, confirming the dot form is correct; this PR's own Testing notes also cite docs/codebud.html/index.html.
Fix: change the copy source to docs/codebud.html/.. With that one change I verified site/ is populated correctly and site/index.html + site/llms.txt are present.
Verified and correct (no change needed):
--no-split→--split=nodeindocs/Makefile.am: builds cleanly, produces the split manual.make htmlis a valid top-level target;configuredeps (requests prompt_toolkit) are sufficient.- Trigger model:
push/pull_requestonmain(path-filtered) +workflow_dispatch. - Security scoping is right: top-level
permissions: contents: read;pages: write/id-token: writeare confined to thedeployjob, which — together with the artifact upload — is gatedif: github.event_name != 'pull_request', so a PR only builds (no deploy, no privileged token, no secrets). Usespull_request, notpull_request_target.
Before merge (maintainer action, not a code change): GitHub Pages must be set to "GitHub Actions" as source, or the deploy job fails on main.
Requesting changes for the one-line path fix; everything else looks good.
b2673b0 to
7cee3c8
Compare
mkhellat
left a comment
There was a problem hiding this comment.
Thank you for addressing the path mismatch (docs/codebud.html/ vs docs/codebud_html/). I have verified the fix and rebased this branch onto current main so it is merge-ready (2 commits ahead, no conflicts).
Please note for future contributions: when a review requests a blocking change, it helps to follow up promptly so the PR does not sit idle for an extended period. Aside from that delay, the change itself looks good.
Approving.
Summary
llms.txtin the published site.Testing
./bootstrapand./configuresuccessfully in Ubuntu WSL.makeandmake -C docs htmlsuccessfully.docs/codebud.html/index.html.index.htmlandllms.txt.Notes
The GitHub Actions workflow still needs CI validation, and GitHub Pages must be configured to allow deployment through GitHub Actions.