0xMiden / 0xMiden/docs

Add standard crates documentation section mirroring Rust client hierarchy

Abierto
#267 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).

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.

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Primero, examinar la jerarquía de documentación existente del cliente Rust para comprender la estructura que se debe reflejar. Luego, localizar las secciones apropiadas en el repositorio de documentación (probablemente bajo Smart Contracts / Tools) donde se deben agregar las páginas de crates estándar. Para cada crate (miden-lib, miden-objects, miden-tx), decidir si se deben ingerir los comentarios de documentación existentes o redactar contenido nuevo, y crear issues de seguimiento para la documentación escasa en los repositorios de origen.

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
55/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.