Skip to content

Commit 09df3c3

Browse files
committed
docs(cpex): use the root README as the crate's crates.io page
Add a shared readme to [workspace.package] (resolved from the workspace root) and inherit it in cpex via readme.workspace = true. cargo bundles the root README into the published .crate, so crates.io/crates/cpex renders the project README with no per-crate duplicate. Verified the file is in 'cargo package --list' and the resolved readme path is ../../README.md. Signed-off-by: Frederico Araujo <frederico.araujo@ibm.com>
1 parent 9f64a52 commit 09df3c3

2 files changed

Lines changed: 7 additions & 0 deletions

File tree

Cargo.toml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,10 @@ repository = "https://github.com/contextforge-org/cpex"
6868
homepage = "https://contextforge-org.github.io/cpex/"
6969
keywords = ["ai", "agent", "security", "policy", "plugin"]
7070
categories = ["development-tools"]
71+
# Shared crate README, resolved relative to this workspace root. Members opt in
72+
# with `readme.workspace = true` (cpex does, for its crates.io page) so the one
73+
# root README is the single source — no per-crate copy.
74+
readme = "README.md"
7175

7276
[workspace.dependencies]
7377
# Minimal tokio feature floor for crates that take `tokio = { workspace = true }`

crates/cpex/Cargo.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@ homepage.workspace = true
2929
keywords.workspace = true
3030
categories.workspace = true
3131
rust-version.workspace = true
32+
# Use the project's root README as this crate's crates.io page (inherited path
33+
# is workspace-root-relative; cargo bundles it into the published .crate).
34+
readme.workspace = true
3235

3336
# Build docs.rs with every extension enabled. The default build is engine-only
3437
# (`default = []`), which omits cpex-builtins entirely — so without this the

0 commit comments

Comments
 (0)