Skip to content

Commit 953f3b8

Browse files
committed
docs: highlight precision navigation in README
1 parent 5bc0712 commit 953f3b8

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,27 @@ What you can generate:
4545

4646
**3. Full Lifecycle** - Covers **complete lifecycle** (creation, updates, maintenance)
4747

48+
**4. Precision-Guided Navigation** - Built-in line-number navigation across 6 core commands lets AI jump directly to relevant sections with `read_file(offset, limit)`, cutting token usage by **84-98%**
49+
50+
---
51+
52+
## 🧭 Token Optimization
53+
54+
MetaSpec 0.5.4 introduces **precision-guided navigation** so AI agents can read just the slices of large command templates they need.
55+
56+
- **How it works**: Every enhanced command begins with a 📖 Navigation Guide listing line ranges. Combine it with `read_file(target_file, offset, limit)` to stream only that segment.
57+
- **Coverage**: `specify` (SDS/SDD), `implement` (SDS/SDD), `tasks` (SDS), `plan` (SDD) — **8615 lines** of navigation guidance overall.
58+
- **Savings**: Real-world scenarios show **84-98% token reductions** (language-specific sections reach **97-98%**).
59+
- **More examples**: See `AGENTS.md`*Token Optimization: Precision-Guided Navigation* for full tables and best practices.
60+
61+
```bash
62+
# Jump straight to CLI design section of SDD/specify
63+
read_file("src/metaspec/templates/meta/sdd/commands/specify.md.j2", offset=390, limit=273)
64+
65+
# Grab Python-specific implementation steps only (97% savings)
66+
read_file("src/metaspec/templates/meta/sdd/commands/implement.md.j2", offset=210, limit=25)
67+
```
68+
4869
---
4970

5071
## 🚀 Quick Start
@@ -437,6 +458,11 @@ uv run mypy src/metaspec # Type check
437458

438459
## 🏗️ Status
439460

461+
**v0.5.4** - Precision-Guided Navigation 🚀
462+
- Added line-number navigation to `specify`, `implement`, `tasks`, `plan` (SDS/SDD) for 84-98% token savings
463+
- Enhanced `/metaspec.*.analyze` with Quick / Focused / Full modes
464+
- Fixed 6 Jinja2 template issues and refreshed documentation (CHANGELOG, AGENTS)
465+
440466
**v0.5.3** - Alpha Release 🎉
441467

442468
Core features complete: YAML validation, multi-domain generation, CLI tools, AI agent support, built-in MetaSpec commands (19 commands: 8 SDS + 8 SDD + 3 Evolution), recursive tree structure for specifications, unified spec interface.

0 commit comments

Comments
 (0)