Skip to content

docs: Publish rustdoc for internal crates alongside mdbook#1892

Merged
cgwalters merged 1 commit intobootc-dev:mainfrom
cgwalters:website-docsrs
Jan 7, 2026
Merged

docs: Publish rustdoc for internal crates alongside mdbook#1892
cgwalters merged 1 commit intobootc-dev:mainfrom
cgwalters:website-docsrs

Conversation

@cgwalters
Copy link
Collaborator

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:

  • Switch docs container to CentOS Stream 10 for newer Rust (1.91)
  • Add native library dependencies needed for cargo doc
  • Build rustdoc with --document-private-items for full coverage
  • Add internals.md page listing all crates with rustdoc links
  • Update Justfile to build from repo root for cargo access

Assisted-by: OpenCode (Opus 4.5)

@github-actions github-actions bot added the area/documentation Updates to the documentation label Jan 7, 2026
@bootc-bot bootc-bot bot requested a review from jeckersb January 7, 2026 18:18
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

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.

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>
@cgwalters cgwalters enabled auto-merge (rebase) January 7, 2026 19:10
Copy link
Collaborator

@jeckersb jeckersb left a comment

Choose a reason for hiding this comment

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

👍 LGTM, tested with a local build and a bit of clicky click to sanity check the links work.

@cgwalters
Copy link
Collaborator Author

tested with a local build

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.

@cgwalters cgwalters merged commit b68100b into bootc-dev:main Jan 7, 2026
46 checks passed
@cgwalters
Copy link
Collaborator Author

Cool, it's live https://bootc-dev.github.io/bootc/internals.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/documentation Updates to the documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants