0xMiden / 0xMiden/docs

Add standard crates documentation section mirroring Rust client hierarchy

Open
#267 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
TypeScript
Stars
10
Forks
50
Avg merge
22d 23h
Merged PRs (30d)
1

Description

Source: DevEx Sync (Notion).

The "standard crates" pages were called out as still needed. The intended shape is to mimic the Rust client's documentation hierarchy (initialization → account APIs → transactions → notes), giving each standard crate (e.g. `miden-lib`, `miden-objects`, `miden-tx`) its own clear API hierarchy in the docs.

Scope:

- Author standard-crates landing page + per-crate sections under the appropriate Smart Contracts / Tools area.
- Mirror the structure Brian has endorsed in the Rust client docs.
- Decide ingestion vs. locally authored on a crate-by-crate basis.

Upstream dependency: where doc comments are sparse, file follow-ups against the source repos (likely in `protocol`) — but the IA + docs framing is owned here.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.