[roeap]

Reviews and improves the rustdoc across the olai-store crate, and fixes a docs.rs build gap so the full API is actually published.

Changes

docs.rs feature build + cfg badges (the impactful fix)
docs.rs builds a crate with its default features only. Since default = [], every sqlite / postgres / encryption item — SqlStore, EnvelopeEncryptor, KeyProvider, and friends — was absent from the published docs.rs page entirely. Added [package.metadata.docs.rs] (all-features = true, --cfg docsrs) and a feature(doc_cfg) gate behind that cfg so feature-gated items render an "available on crate feature X" badge. docs.rs builds on nightly, so the unstable feature is only ever touched there; stable/MSRV builds never see it, and a [lints.rust] check-cfg entry keeps docsrs from tripping unexpected_cfgs.

Note: the gate is doc_cfg, not doc_auto_cfg — the latter was removed in 1.92.0 and merged into doc_cfg (rust-lang/rust#138907). doc_cfg is still unstable, so this is a nightly-only docsrs gate, not an MSRV bump.

Feature-gated intra-doc links
Links to EnvelopeEncryptor / with_encryptor lived in always-compiled modules but pointed at encryption-gated items, so a default-feature RUSTDOCFLAGS="-D warnings" cargo doc failed with unresolved-link errors (masked on docs.rs, which builds all features). Converted to code spans naming the feature. Docs now build clean under default, sqlite, encryption, and --all-features.

Stale field-role note (registry.rs)
FieldRole::Sensitive said "routed to the secret store" — outdated since the inline envelope-encrypted blob. Updated.

name.rs documentation
Module-level overview of the dotted, backtick-escaped string form, a runnable round-trip example on ResourceName, a doc for EMPTY_RESOURCE_NAME, and # Errors sections + examples on FromStr, parse_column_name_list, and prefix_matches.

Also ran the humanizer patterns over the docs: no changes needed (elevated em-dash counts are legitimate technical apposition, boldface is load-bearing, no AI-vocabulary slop).

Verification

• cargo doc -D warnings clean under default / encryption / sqlite / --all-features
• Simulated docs.rs build (RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-features): compiles, and the "Available on crate feature encryption/sqlite" badges render
• cargo test --doc --all-features — 9 passed (incl. 2 new doctests)
• cargo fmt + cargo clippy --all-features --all-targets -D warnings clean

This pull request was AI-assisted by Isaac.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!