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
This commit is contained in:
@@ -0,0 +1,67 @@
|
||||
# docs-rag
|
||||
|
||||
Retrieval-augmented generation over a local `docs/` directory of 3GPP Release 19 specifications.
|
||||
|
||||
## Architecture
|
||||
|
||||

|
||||
|
||||
## Workflow
|
||||
|
||||

|
||||
|
||||
## 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
|
||||
```
|
||||
@@ -0,0 +1,24 @@
|
||||
@startuml docs-rag-architecture
|
||||
skinparam componentStyle rectangle
|
||||
skinparam defaultFontName Arial
|
||||
skinparam backgroundColor #FAFAFA
|
||||
|
||||
package "docs-rag Skill" {
|
||||
component "SKILL.md\n(instructions)" as SKILL
|
||||
component "data/index.json\n(spec, title, keywords,\nsummary, file path)" as INDEX
|
||||
component "evals/evals.json" as EVALS
|
||||
}
|
||||
|
||||
package "Source Documents" {
|
||||
database "docs/\n*.docx / *.doc\n(3GPP specs)" as DOCS
|
||||
component "scripts/build_index.py\n(index builder)" as BUILDER
|
||||
}
|
||||
|
||||
actor Developer
|
||||
|
||||
Developer --> SKILL : 3GPP question
|
||||
SKILL --> INDEX : keyword + semantic match
|
||||
INDEX --> DOCS : read file (deep detail)
|
||||
BUILDER --> INDEX : builds / updates
|
||||
DOCS --> BUILDER : scans
|
||||
@enduml
|
||||
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 7.6 KiB |
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 9.0 KiB |
@@ -0,0 +1,24 @@
|
||||
@startuml docs-rag-workflow
|
||||
skinparam defaultFontName Arial
|
||||
skinparam backgroundColor #FAFAFA
|
||||
|
||||
actor Developer
|
||||
participant "docs-rag\nSkill" as SKILL
|
||||
participant "data/index.json" as INDEX
|
||||
participant "docs/*.docx" as DOCS
|
||||
|
||||
Developer -> SKILL : 3GPP question
|
||||
SKILL -> INDEX : read index
|
||||
INDEX --> SKILL : entries (keywords, summary, path)
|
||||
SKILL -> SKILL : match query vs keywords & summary
|
||||
|
||||
alt summary sufficient
|
||||
SKILL --> Developer : answer from summary\n+ cite spec + version
|
||||
else need deeper detail
|
||||
SKILL -> DOCS : read source file
|
||||
DOCS --> SKILL : full spec content
|
||||
SKILL --> Developer : detailed answer\n+ cite spec + version
|
||||
else no match
|
||||
SKILL --> Developer : "No matching document found"
|
||||
end
|
||||
@enduml
|
||||
Reference in New Issue
Block a user