0xMiden / 0xMiden/docs

Improve MASM docs discoverability and depth in IA

Open
#266 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).

MASM reference documentation currently lives under Core Concepts / Protocol but is not intuitive to find for developers writing MASM. Two options were discussed:

1. Stand up a dedicated Miden-flavoured MASM section (e.g. top-level `/masm/` or under Tools), authored in this repo.
2. Update the docs ingestion logic so MASM reference pages from the upstream source are pulled into a more discoverable location with proper sidebar grouping.

Additionally:

- Several MASM pages (and project-template pages) are currently single-page stubs and need deeper content per page rather than one wall.
- Sidebar/IA placement should make the MASM reference reachable in ≤ 2 clicks from the home page.

This issue tracks both the IA decision and the resulting content/ingestion work.

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.