Skip to content

docs: add and fix crate-level documentation for all CosmWasm crates #2510

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 13 commits into
base: main
Choose a base branch
from

Conversation

GarmashAlex
Copy link

Fix #2234

This commit adds or updates crate-level documentation comments (//! ...) for all main CosmWasm crates in the repository.

  • Each crate now includes a brief description of CosmWasm, its purpose, and a link to the official documentation at https://docs.cosmwasm.com.
  • For internal or derive crates, the documentation clearly states that they are for internal use only.
  • All crate-level doc comments are placed at the very top of each file to comply with Rust linter requirements and avoid documentation-related linter errors.
  • This improves discoverability, consistency, and onboarding for new users and contributors.

Copy link
Contributor

@chipshort chipshort left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice stuff! I put some comments inline.

@GarmashAlex GarmashAlex requested a review from chipshort August 25, 2025 07:33
@GarmashAlex
Copy link
Author

@chipshort So sorry for late answer, corrected docs

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.

Improve crate level docs
2 participants