StackGuardian/tirith

Create documentation structure for tirith and bootstrap docs

Ouverte

#131 ouverte le 20 avr. 2024

Voir sur GitHubGuide contributeur
 (10 commentaires) (0 réaction) (1 personne assignée)Python (41 forks)auto 404
enhancementhacktoberfest

Métriques du dépôt

Stars
 (168 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

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

Guide contributeur

Direction de recherche
Examinez des structures de documentation comme ReadTheDocs et explorez comment optimiser la documentation pour le RAG (par exemple en utilisant des bases de données vectorielles). Comparez plusieurs options de structure en mettant l'accent sur la compatibilité RAG et la lisibilité humaine.
Stack technique
python
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
GitDocumentation tools (e.g., Sphinx, MkDocs)
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60