docs: Publish rustdoc for internal crates alongside mdbook#1892
docs: Publish rustdoc for internal crates alongside mdbook#1892cgwalters merged 1 commit intobootc-dev:mainfrom
Conversation
There was a problem hiding this comment.
Code Review
This pull request effectively integrates rustdoc generation for internal crates into the documentation website. The changes to the Justfile and docs/Dockerfile.mdbook are well-reasoned to accommodate the new build steps, and the new internals.md page provides a clear entry point to the API documentation. I have one suggestion to improve the Docker build caching for the documentation, which should speed up the process on subsequent runs.
4e9fd42 to
35203ea
Compare
The docs workflow now also generates rustdoc for all workspace crates and publishes them as a subdirectory of the main documentation site. This makes internal API documentation available at bootc-dev.github.io/bootc/internals.html with links to each crate. Note this required switching the docs container to CentOS Stream 10 for newer Rust (1.91). Assisted-by: OpenCode (Opus 4.5) Signed-off-by: Colin Walters <walters@verbum.org>
35203ea to
61122d0
Compare
jeckersb
left a comment
There was a problem hiding this comment.
👍 LGTM, tested with a local build and a bit of clicky click to sanity check the links work.
Thanks for doing that! I had done so myself as well, but with things like this having human eyes on it is useful as it's harder to "statically" check. BTW I had AI do the initial pass at this and it ended up doing lots of stuff in the GHA workflow and I told it "no all work needs to be in the Justfile and container build" for precisely this reason of making it easy to run locally too. I'm pretty happy with how the Justfile stuff is working out. |
|
Cool, it's live https://bootc-dev.github.io/bootc/internals.html |
The docs workflow now also generates rustdoc for all workspace crates and publishes them as a subdirectory of the main documentation site. This makes internal API documentation available at bootc-dev.github.io/bootc/internals.html with links to each crate.
Changes:
Assisted-by: OpenCode (Opus 4.5)