Docs: Structural Restructuring
- Vorherrschende Sprache
- TypeScript
- Sterne
- 10
- Forks
- 50
- Ø Merge
- 22 T. 23 Std.
- Gemergte PRs (30 T.)
- 1
Beschreibung
The current client documentation IMHO could make use of better structuring.
**Proposed structural changes:**
- Create new "SDK / Library" section containing:
- "Library" section content
- Current TypeScript content (as "Rust" and "TypeScript" subsections)
- Create new "CLI" section with most current "Client → Rust" content
- Remove empty "Examples" section that only points to Rust section
This structure would give a better and more structured overview to readers, and avoid unnecessary complication / duplication.
Beitragsleitfaden
Rechercherichtung
Überprüfen Sie die aktuelle Dokumentationsstruktur im Repository, um die bestehenden Abschnitte 'Library', 'Client → Rust' und 'Examples' zu verstehen. Ordnen Sie die vorgeschlagenen neuen Abschnitte zu ('SDK / Library' mit Unterabschnitten für Rust und TypeScript sowie einen separaten 'CLI'-Abschnitt). Die Arbeit besteht in der Reorganisation von Inhalten, nicht im Verfassen neuer Texte. Prüfen Sie vorhandene Dokumentationsrichtlinien oder Navigationskonfigurationsdateien, um zu verstehen, wie Abschnitte definiert sind.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Klar beschrieben
- Anfängerfreundlichkeit
- 55/100