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

GarmashAlex · 2025-06-26T09:40:13Z

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.

chipshort

Nice stuff! I put some comments inline.

packages/check/src/main.rs

packages/crypto/src/lib.rs

GarmashAlex · 2025-08-25T07:34:16Z

@chipshort So sorry for late answer, corrected docs

packages/cw-schema-derive/src/lib.rs

packages/cw-schema/src/lib.rs

packages/derive/src/lib.rs

packages/schema-derive/src/lib.rs

packages/schema/src/lib.rs

packages/std/src/lib.rs

packages/vm-derive/src/lib.rs

packages/vm/src/lib.rs

GarmashAlex added 11 commits June 26, 2025 12:36

docs: add crate-level documentation with CosmWasm overview and docs link

a9150b6

Update main.rs

c0c317d

Update lib.rs

8ff3745

Update lib.rs

baeaf43

Update lib.rs

da7f299

Update lib.rs

2ed5801

Update lib.rs

24ebb26

Update lib.rs

448b12d

Update lib.rs

311aab6

Update lib.rs

6d6787b

Update lib.rs

ea1056f

chipshort reviewed Jun 26, 2025

View reviewed changes

packages/check/src/main.rs Outdated Show resolved Hide resolved

packages/crypto/src/lib.rs Outdated Show resolved Hide resolved

GarmashAlex added 2 commits August 25, 2025 10:32

fix link

5c68df5

fix note

96a9128

GarmashAlex requested a review from chipshort August 25, 2025 07:33

DariuszDepta requested review from DariuszDepta and removed request for chipshort August 25, 2025 13:10

DariuszDepta added the maintenance Maintenance label Aug 25, 2025

DariuszDepta added this to the 3.0.2 milestone Aug 25, 2025

DariuszDepta assigned GarmashAlex Aug 25, 2025