StackGuardian/tirith

Create documentation structure for tirith and bootstrap docs

Offen

#131 geöffnet am 20.04.2024

Auf GitHub ansehenContributor Guide
 (10 Kommentare) (0 Reaktionen) (1 zugewiesene Person)Python (41 Forks)auto 404
enhancementhacktoberfest

Repository-Metriken

Stars
 (168 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

Brainstorm about:

  • What are the structures for the docs? (a good start would be to research readthedocs)
  • Good docs examples
  • Best if the docs is optimized for vector database for integration with the RAG

Update (22/04/2024):

  • Find the right structure and write a concrete docs, would be great if we have multiple structure options to compare
    • Goal: optimized for RAG, readable for human

cc @samriddhi99

Contributor Guide

Research-Richtung
Untersuche Dokumentationsstrukturen wie ReadTheDocs und erkunde, wie man Dokumentation für RAG optimiert (z. B. mit Vektordatenbanken). Vergleiche mehrere Strukturoptionen mit Fokus auf RAG Kompatibilität und Lesbarkeit für Menschen.
Tech Stack
python
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
GitDocumentation tools (e.g., Sphinx, MkDocs)
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60