Skip to content

Commit 8cbd6e9

Browse files
committed
docs: Add composefs-rs crates to internals rustdoc
These external git dependencies don't have docs on docs.rs, so include them in the internal documentation alongside our workspace crates. Assisted-by: OpenCode (Opus 4.5) Signed-off-by: Colin Walters <walters@verbum.org>
1 parent fd7f1b6 commit 8cbd6e9

2 files changed

Lines changed: 10 additions & 0 deletions

File tree

docs/Dockerfile.mdbook

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ RUN --mount=type=cache,target=/src/target <<EORUN
1717
set -xeuo pipefail
1818
# Build rustdoc for internal crates
1919
cargo doc --workspace --no-deps --document-private-items
20+
# Also build docs for key external git dependencies (not on docs.rs)
21+
cargo doc --no-deps --document-private-items -p composefs -p composefs-boot -p composefs-oci
2022
# Build mdbook
2123
cd docs
2224
mdbook-mermaid install .

docs/src/internals.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,11 @@ These are intended for developers working on bootc itself, not for external cons
2222
- [bootc-internal-blockdev](internals/bootc_internal_blockdev/index.html) - Block device handling
2323
- [bootc-sysusers](internals/bootc_sysusers/index.html) - systemd-sysusers implementation
2424
- [bootc-tmpfiles](internals/bootc_tmpfiles/index.html) - systemd-tmpfiles implementation
25+
26+
## External git crates
27+
28+
These crates are pulled from git and are not published to crates.io (so not on docs.rs).
29+
30+
- [composefs](internals/composefs/index.html) - Core composefs library
31+
- [composefs-boot](internals/composefs_boot/index.html) - Boot support for composefs
32+
- [composefs-oci](internals/composefs_oci/index.html) - OCI integration for composefs

0 commit comments

Comments
 (0)