tech-docs-kb

Search internal technical documentation via AWS Bedrock Knowledge Base.

Updated Jun 1, 2023
One-click install
npx skills add https://github.com/ErebusBat/chezmoi --skill tech-docs-kb
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: tech-docs-kb
Source: https://github.com/ErebusBat/chezmoi/tree/main/dot_config/opencode/skill/tech-docs-kb
Command: npx skills add https://github.com/ErebusBat/chezmoi --skill tech-docs-kb

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill allows users to quickly find information within a large corpus of internal technical documentation, including ADRs, RFCs, runbooks, and architecture guides, without needing to clone the repository.

Core Features & Use Cases

  • Semantic and Hybrid Search: Leverages AWS Bedrock Knowledge Base for advanced search capabilities.
  • Comprehensive Coverage: Indexes a wide range of documentation types across various project areas.
  • Use Case: A developer needs to understand the deployment procedure for a new service. They can use this Skill to search for relevant runbooks and deployment guides.

Quick Start

Use the tech-docs-kb skill to search for information on how services work.

Frequently Asked Questions about tech-docs-kb

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I search internal technical documentation without cloning the repository?

Use this Skill to search internal technical documentation directly against the indexed corpus, eliminating the need to manually clone the repository to find ADRs, RFCs, or runbooks.

How does semantic and hybrid search work over technical runbooks and architecture guides?

Semantic and hybrid search over runbooks and architecture guides is powered by AWS Bedrock Knowledge Base, which indexes the 'lightspeed-hospitality/tech-docs' corpus to retrieve relevant context.

What do I need to authenticate and retrieve technical documentation using AWS Bedrock?

To retrieve technical documentation via AWS Bedrock, you need AWS CLI v2 installed, an active granted CLI session, and a specific AWS profile configured for Knowledge Base authentication.

Can I find deployment procedures for a new service in the technical documentation knowledge base?

Yes, you can find deployment procedures by searching the technical documentation knowledge base, which indexes deployment guides and runbooks across various project areas for quick retrieval.

What types of technical documents are indexed in the AWS Bedrock knowledge base?

The AWS Bedrock knowledge base indexes a comprehensive range of technical documents, including ADRs, RFCs, runbooks, architecture guides, and deployment procedures across various project areas.

Are there limitations when searching internal technical documentation with AWS Bedrock?

A key limitation is that searching internal technical documentation requires specific AWS authentication dependencies, including AWS CLI v2, granted CLI, and a specific AWS profile, restricting access without proper setup.