Files
common-skills/skills/docs-rag/README.md
T
Team c0d14c6ac1 chore: restructure skills repo with new agents and skill bundles
- Add new skills: deep-dive, docs-rag, meta-creator, ppt-maker, sdlc
- Add agent configs: g-assistent, meta-creator, sdlc with prompt files
- Add reference docs for custom agents and skills specification
- Add utility scripts: install-agents.sh, orchestrate.py, puml2svg.sh
- Update README and commit-message skill config
- Remove deprecated skills: codereview, python, testing, typescript
- Add .gitignore
2026-04-18 13:07:46 +08:00

68 lines
1.7 KiB
Markdown

# docs-rag
Retrieval-augmented generation over a local `docs/` directory of 3GPP Release 19 specifications.
## Architecture
![Architecture](assets/docs-rag-architecture.svg)
## Workflow
![Workflow](assets/docs-rag-workflow.svg)
## When to Use
- Questions about 3GPP specs, Release 19 features, mission critical services, ambient IoT, ISAC, UAV/drone support, network sharing, SNPN interconnect, traffic steering/split
- Rebuilding or refreshing the document index after adding new files
## How It Works
1. Reads `data/index.json` (spec number, title, keywords, summary, file path)
2. Matches the query against `keywords` and `summary` fields
3. Answers from the summary if sufficient; reads the actual file for deeper detail
4. Always cites the spec number and version in the answer
## Indexed Documents
| Spec | Title |
|------|-------|
| TS 22.280 | Mission Critical Services Common Requirements |
| TS 22.369 | Service Requirements for Ambient IoT |
| TR 22.837 | Integrated Sensing and Communication (ISAC) |
| TR 22.840 | Study on Ambient Power-enabled IoT |
| TR 22.841 | Traffic Steer/Switch/Split over Dual 3GPP Access |
| TR 22.843 | UAV Phase 3 |
| TR 22.848 | Interconnect of SNPN |
| TR 22.851 | Network Sharing Feasibility Study |
## Maintaining the Index
```bash
# Full rebuild
python scripts/build_index.py
# Incremental update (skips unchanged files)
python scripts/build_index.py --update
```
## File Structure
```
skills/docs-rag/
├── SKILL.md
├── README.md # this file
├── assets/
│ ├── workflow.puml
│ └── docs-rag-workflow.svg
├── data/
│ └── index.json # document index
└── evals/
└── evals.json
```
## Evals
```bash
python scripts/run_evals.py docs-rag
```