Add high-level diagrams + project map to connect concepts (docs)
- Vorherrschende Sprache
- TypeScript
- Sterne
- 10
- Forks
- 50
- Ø Merge
- 22 T. 23 Std.
- Gemergte PRs (30 T.)
- 1
Beschreibung
Feedback:
Docs would benefit from high-level diagrams and a project map that connects **concepts, tooling, and contract logic.** Right now, it can feel fragmented without a “big picture” view.
Ask:
- Add diagrams showing how the main pieces (contracts, tooling, proving, accounts, etc.) fit together.
- Provide a project map that connects concepts to the right crates/SDKs/docs.
Why:
Gives developers a mental model of the whole system and makes it easier to navigate from big-picture to details.
**This feedback came through DevRel applications.**
Beitragsleitfaden
Rechercherichtung
Das Issue fordert hochrangige Diagramme und eine Projektkarte, die Konzepte, Tooling und Vertragslogik verbindet. Beginnen Sie damit, die bestehende Dokumentationsstruktur zu erkunden, um die Hauptbestandteile zu verstehen: Verträge, Tooling, Beweisführung, Konten. Identifizieren Sie die wichtigsten Crates und SDKs, die im Codebase erwähnt werden. Erstellen Sie Diagramme, die zeigen, wie diese Komponenten interagieren, und ordnen Sie dann Konzepte den relevanten Dokumentationsabschnitten zu. Das Ziel ist es, visuelle Hilfsmittel zu erstellen, die Entwicklern ein kohärentes mentales Modell des Miden-Rollup-Systems vermitteln.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100