0xMiden / 0xMiden/docs

Improve MASM docs discoverability and depth in IA

Abierto
#266 0 comentarios 0 reacciones 0 asignados Ver en GitHub
documentation
Lenguaje dominante
TypeScript
Estrellas
10
Forks
50
Merge medio
22 d 23 h
PR fusionados (30 d)
1

Descripción

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.

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

The issue is about the documentation site's information architecture and content. First, examine the repository structure to understand how docs are organized and ingested. Look for sidebar configuration and the location of MASM-related pages. The goal is to make MASM reference documentation more discoverable and expand stub pages, but the specific changes depend on an IA decision not yet made.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
typescript
Área
documentation
Tipo de issue
Documentación
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
45/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.