StackGuardian/tirith

Create documentation structure for tirith and bootstrap docs

Open

#131 opened on Apr 20, 2024

View on GitHubContributor guide
 (10 comments) (0 reactions) (1 assignee)Python (41 forks)auto 404
enhancementhacktoberfest

Repository metrics

Stars
 (168 stars)
PR merge metrics
 (PR metrics pending)

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

Contributor guide

Research direction
Investigate documentation structures like ReadTheDocs, and explore how to optimize docs for RAG (e.g., using vector databases). Compare multiple structure options focusing on RAG compatibility and human readability.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GitDocumentation tools (e.g., Sphinx, MkDocs)
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60