Skip to content

docs: migrate // comments to /// rustdoc across all 6 contract crates - #50

Open
chazepay wants to merge 1 commit into
Kqirox:mainfrom
chazepay:docs/migrate-comments-to-rustdoc
Open

docs: migrate // comments to /// rustdoc across all 6 contract crates#50
chazepay wants to merge 1 commit into
Kqirox:mainfrom
chazepay:docs/migrate-comments-to-rustdoc

Conversation

@chazepay

Copy link
Copy Markdown
  • Replace floating // block comments at module level with //! crate-level docs
  • Add structured /// rustdoc (# Arguments, # Returns, # Panics, # Examples) to
    every public fn, struct, enum variant, event struct, and const in all 6 crates:
    badge-nft, course-registry, reward-pool, stake-vault, quest-engine, governance
  • Add 5+ doctests in /// blocks across badge-nft, course-registry, stake-vault,
    reward-pool, and governance
  • Remove inline // step-comment scaffolding from all function bodies
  • Add storage-layout tables to all DataKey and struct type docs
  • Add cargo doc --no-deps --document-private-items zero-warning check to CI
  • Add docs publish job to GitHub Pages on version tags (v*)

Closes #23

… - Replace floating // block comments at module level with //! crate-level docs - Add structured /// rustdoc (# Arguments, # Returns, # Panics, # Examples) to every public fn, struct, enum variant, event struct, and const in all 6 crates: badge-nft, course-registry, reward-pool, stake-vault, quest-engine, governance - Add 5+ doctests in /// blocks across badge-nft, course-registry, stake-vault, reward-pool, and governance - Remove inline // step-comment scaffolding from all function bodies - Add storage-layout tables to all DataKey and struct type docs - Add cargo doc --no-deps --document-private-items zero-warning check to CI - Add docs publish job to GitHub Pages on version tags (v*) Closes Kqirox#23
@merlik787-droi

Copy link
Copy Markdown
Contributor

@chazepay resolve conflicts

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.

[23] Add weaving of rustdoc into hosted docs (docs.rs / GitHub Pages)

2 participants