0xMiden / 0xMiden/docs

Ingest Miden Up docs from miden-up repo into docs.miden.xyz

Open
#263 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 Miden Up content authored for the Lambda class PR has not yet landed in `docs.miden.xyz`. Currently Miden Up docs are sparse and not integrated into the new v0.14 IA (Get Started / Tools / Tutorials).

Proposed approach (per discussion):

- Create a `docs/` folder inside the `miden-up` repo and have `docs.miden.xyz` ingest it (mirroring how the Rust client docs are pulled from `miden-client/`), instead of authoring a single giant page in this repo.
- Land the existing Lambda-class Miden Up walkthrough as the first ingested content.
- Extend the docs deploy workflow (`.github/workflows/deploy-docs.yml`) to whitelist the new path.

Owner per meeting: Philipp.

Upstream dependency: requires a `docs/` folder + structure to be set up in the `miden-up` repo first; this issue tracks the docs-side ingestion + IA placement.

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.