Description
Smart contract source code has inline Rust documentation comments (///) but no generated docs. Build and publish documentation to GitHub Pages so developers can understand contract interfaces without reading source code.
Definition of Done
Acceptance Criteria
cargo doc --no-deps --open shows all public API documentation
- Doc examples pass with
cargo test --doc
- Published docs accessible at .github.io/AetherMint/contracts
- Every public function has a doc comment
Files to Modify
contracts/src/lib.rs — ensure module doc and re-exports are documented
contracts/src/credentials.rs — add/improve doc comments
contracts/src/courseMetadata.rs — add/improve doc comments
contracts/src/governance.rs — add/improve doc comments
contracts/src/marketplace.rs — add/improve doc comments
contracts/src/tokenomics.rs — add/improve doc comments
contracts/src/dynamic_nft.rs — add/improve doc comments
contracts/src/dna_storage.rs — add/improve doc comments
contracts/src/attestation_protocol.rs — add/improve doc comments
contracts/src/user_profile.rs — add/improve doc comments
contracts/src/credential_registry.rs — add/improve doc comments
- New file:
.github/workflows/docs.yml — build and publish docs
Description
Smart contract source code has inline Rust documentation comments (
///) but no generated docs. Build and publish documentation to GitHub Pages so developers can understand contract interfaces without reading source code.Definition of Done
///doc comments with parameters and return valuescargo test --doccargo doc --no-depsgenerates clean HTML documentationAcceptance Criteria
cargo doc --no-deps --openshows all public API documentationcargo test --docFiles to Modify
contracts/src/lib.rs— ensure module doc and re-exports are documentedcontracts/src/credentials.rs— add/improve doc commentscontracts/src/courseMetadata.rs— add/improve doc commentscontracts/src/governance.rs— add/improve doc commentscontracts/src/marketplace.rs— add/improve doc commentscontracts/src/tokenomics.rs— add/improve doc commentscontracts/src/dynamic_nft.rs— add/improve doc commentscontracts/src/dna_storage.rs— add/improve doc commentscontracts/src/attestation_protocol.rs— add/improve doc commentscontracts/src/user_profile.rs— add/improve doc commentscontracts/src/credential_registry.rs— add/improve doc comments.github/workflows/docs.yml— build and publish docs