StackGuardian/tirith

Create documentation structure for tirith and bootstrap docs

Aberta

#131 aberto em 20 de abr. de 2024

Ver no GitHubGuia do colaborador
 (10 comentários) (0 reação) (1 responsável)Python (41 forks)auto 404
enhancementhacktoberfest

Métricas do repositório

Stars
 (168 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

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

Guia do colaborador

Direção de pesquisa
Investigue estruturas de documentação como ReadTheDocs e explore como otimizar a documentação para RAG (ex.: usando bancos de dados vetoriais). Compare várias opções de estrutura com foco na compatibilidade com RAG e legibilidade humana.
Pilha de tecnologia
python
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
GitDocumentation tools (e.g., Sphinx, MkDocs)
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60