Skip to content

feat(doc): Build and publish the documentation on GitHub Pages - #230

Merged
tperami merged 1 commit into
mainfrom
doc-site
Aug 27, 2026
Merged

feat(doc): Build and publish the documentation on GitHub Pages#230
tperami merged 1 commit into
mainfrom
doc-site

Conversation

@tperami

@tperami tperami commented Aug 25, 2026

Copy link
Copy Markdown
Collaborator

CI now runs dune build @doc, so will catch a breakage in doc comments.
On a push to main, the coqdoc and odoc output is assembled into a
single website that is deployed to GitHub Pages.

The website can be locally build with make doc-site and opened with
make open-doc-site

A common index page (etc/doc-index.html) has been added.

This is mostly vibe-coded by Claude (Opus 5), I especially didn't bother
understanding the CSS, but it looks nice in my browser

Comment thread .github/workflows/ci.yml
Comment thread Makefile
Comment thread Makefile
@tperami
tperami force-pushed the doc-site branch 3 times, most recently from 268768d to 8207831 Compare August 27, 2026 10:49
CI now runs `dune build @doc`, so will catch a breakage in doc comments.
On a push to main, the coqdoc and odoc output is assembled into a 
single website that is deployed to GitHub Pages.

The website can be locally build with `make doc-site` and opened with
`make open-doc-site`

A common index page (etc/doc-index.html) has been added.

This is mostly vibe-coded by Claude (Opus 5), I especially didn't bother
understanding the CSS, but it looks nice in my browser

Assisted-by: Claude Opus 5
@tperami
tperami added this pull request to the merge queue Aug 27, 2026
Merged via the queue into main with commit 88a897b Aug 27, 2026
2 checks passed
@tperami
tperami deleted the doc-site branch August 27, 2026 15:36
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.

2 participants