Skip to content

docs: enable missing_docs across remaining 8 workspace crates - #3501

Closed
jewoos2921 wants to merge 1 commit into
block:mainfrom
jewoos2921:docs/remaining-crates-missing-docs
Closed

docs: enable missing_docs across remaining 8 workspace crates#3501
jewoos2921 wants to merge 1 commit into
block:mainfrom
jewoos2921:docs/remaining-crates-missing-docs

Conversation

@jewoos2921

Copy link
Copy Markdown

Summary

Completes the workspace-wide missing_docs effort. Combined with #3469 and #3500, every workspace crate now enforces #![warn(missing_docs)].

Crates documented (~600 items, 684 insertions)

Crate Items Key areas
buzz-pair-relay 3 Relay struct + constructor
buzz-media 55 MediaError variants, bucket_index/storage fields
buzz-agent 127 types.rs enums/structs/methods, auth.rs/config.rs APIs
buzz-relay-mesh 192 mesh traits, peer/endpoint/gossip/wire/status APIs
buzz-push-gateway 223 apns/app_attest/authority/grant/model/token APIs
buzz-conformance 0 Attribute only — already fully documented
git-credential-nostr 0 Attribute only
git-sign-nostr 0 Attribute only

Also fixed several pre-existing broken intra-doc links surfaced during the doc build.

Verification

  • RUSTDOCFLAGS="-W missing_docs" cargo doc0 missing warnings across all 8 crates
  • cargo clippy -- -D warnings — clean
  • cargo fmt --check — clean

Workspace-wide result

After #3469 + #3500 + this PR, all 23 workspace crates enforce missing_docs:

buzz-agent ✅    buzz-acp ✅*      buzz-audit ✅     buzz-auth ✅
buzz-cli ✅*      buzz-conformance ✅ buzz-core ✅    buzz-db ✅
buzz-dev-mcp ✅*  buzz-media ✅      buzz-pair-relay ✅ buzz-persona ✅*
buzz-pubsub ✅   buzz-push-gateway ✅ buzz-relay ✅   buzz-relay-mesh ✅
buzz-sdk ✅      buzz-search ✅     buzz-test-client ✅ buzz-workflow ✅
buzz-ws-client ✅*  git-credential-nostr ✅  git-sign-nostr ✅

(* = added in #3469 or #3500)

Complete the workspace-wide missing_docs effort. With #3469 (buzz-cli,
buzz-acp, buzz-dev-mcp, buzz-ws-client) and #3500 (buzz-persona), this
PR covers the final 8 crates. Every workspace crate now enforces
#![warn(missing_docs)].

## Crates documented (~600 items total)

- buzz-pair-relay (3 items): Relay struct + constructor
- buzz-media (55 items): MediaError variants, bucket_index/storage fields
- buzz-agent (127 items): types.rs enums/structs, auth.rs/config.rs APIs
- buzz-relay-mesh (192 items): mesh traits, peer/endpoint/gossip/wire APIs
- buzz-push-gateway (223 items): apns/app_attest/authority/grant/model APIs
- buzz-conformance (0 items): attribute only — already fully documented
- git-credential-nostr (0 items): attribute only
- git-sign-nostr (0 items): attribute only

Also fixed several pre-existing broken intra-doc links that surfaced
during the doc build (buzz-media, buzz-agent).

All changes are doc-comment-only (684 insertions, 27 deletions — the
deletions are mechanical doc-link/format fixes).
@jewoos2921
jewoos2921 requested a review from a team as a code owner July 29, 2026 09:43
@jewoos2921

Copy link
Copy Markdown
Author

Closing — removing this PR.

@jewoos2921 jewoos2921 closed this Jul 29, 2026
@jewoos2921
jewoos2921 deleted the docs/remaining-crates-missing-docs branch July 29, 2026 09:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant