Skip to content

Latest commit

 

History

History
31 lines (19 loc) · 630 Bytes

File metadata and controls

31 lines (19 loc) · 630 Bytes

Docs Buddy

Navigate docs like a Pro.

Use AI magic to help you find answers from Markdown documentation in a git repository.

Major functionality

  • Updating the documentation from Github.
  • Indexing the documentation
  • Answering queries from the documentation

Updating the documentation

  • Sync the repository
  • Extract the raw markdown doc files
  • Extract the document metadata (front-matter)
  • Chunk the documents

Indexing the documentation

  • The document chunks are indexed for both lexical and semantic search

Design

Detailed design can be found in the design doc