docs-reading

What problem does it solve?

This Skill simplifies the process of reading and referencing large technical documentation corpora, enabling fast and comprehensive information retrieval.

Core Features & Use Cases

• Full-Text Search: Index and search technical documentation for specific keywords or terms.
• Semantic Search: Leverage natural language processing to find semantically similar information.
• Database Management: Store and manage documentation data in a local SQLite database for quick access.
• Use Case: If you have a complex library or framework with extensive documentation, this Skill allows you to efficiently find and reference relevant sections without manually searching through the entire document.

Quick Start

To start using the docs-reading skill, first, parse your documentation into the database using the following command:

uv run scripts/parse_docs.py --input /path/to/docs --db ./docs.db --corpus-name mylib --corpus-version 1.0

Once the documentation is parsed, you can use the agent-docs-search tool to search or retrieve information from the database:

agent-docs-search --db /path/to/skill/dbs/name.db search "your query" --corpus mylib --version 1.0