StackGuardian/tirith

Create documentation structure for tirith and bootstrap docs

Aperta

#131 aperta il 20 apr 2024

Vedi su GitHubGuida contributor
 (10 commenti) (0 reazioni) (1 assegnatario)Python (41 fork)auto 404
enhancementhacktoberfest

Metriche repository

Star
 (168 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Esplora strutture di documentazione come ReadTheDocs e scopri come ottimizzare i documenti per RAG (es. utilizzando database vettoriali). Confronta più opzioni di struttura concentrandoti sulla compatibilità RAG e sulla leggibilità umana.
Tech stack
python
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
GitDocumentation tools (e.g., Sphinx, MkDocs)
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60