chore: Bump version to 2.7.4 for language link fix
This patch release fixes the broken Chinese language selector link on PyPI by using absolute GitHub URLs instead of relative paths. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This commit is contained in:
yusyus
353
docs/roadmap/README.md
Normal file
353
docs/roadmap/README.md
Normal file
@@ -0,0 +1,353 @@
|
||||
# Skill Seekers Intelligence System - Documentation Index
|
||||
|
||||
**Status:** 🔬 Research & Design Phase
|
||||
**Last Updated:** 2026-01-20
|
||||
|
||||
---
|
||||
|
||||
## 📚 Documentation Overview
|
||||
|
||||
This directory contains comprehensive documentation for the **Skill Seekers Intelligence System** - an auto-updating, context-aware, multi-skill codebase intelligence system.
|
||||
|
||||
### What Is It?
|
||||
|
||||
An intelligent system that:
|
||||
1. **Detects** your tech stack automatically (FastAPI, React, PostgreSQL, etc.)
|
||||
2. **Generates** separate skills for libraries and codebase modules
|
||||
3. **Updates** skills automatically when branches merge (git-based triggers)
|
||||
4. **Clusters** skills intelligently - loads only relevant skills based on what you're working on
|
||||
5. **Integrates** with Claude Code via plugin system
|
||||
|
||||
**Think of it as:** A self-maintaining RAG system for your codebase that knows exactly which knowledge to load based on context.
|
||||
|
||||
---
|
||||
|
||||
## 📖 Documents
|
||||
|
||||
### 1. [SKILL_INTELLIGENCE_SYSTEM.md](SKILL_INTELLIGENCE_SYSTEM.md)
|
||||
**The Roadmap** - Complete development plan
|
||||
|
||||
**What's inside:**
|
||||
- Vision and goals
|
||||
- System architecture overview
|
||||
- 5 development phases (0-5)
|
||||
- Detailed milestones for each phase
|
||||
- Success metrics
|
||||
- Timeline estimates
|
||||
|
||||
**Read this if you want:**
|
||||
- High-level understanding of the project
|
||||
- Development phases and timeline
|
||||
- What gets built when
|
||||
|
||||
**Size:** 38 pages, ~15K words
|
||||
|
||||
---
|
||||
|
||||
### 2. [INTELLIGENCE_SYSTEM_ARCHITECTURE.md](INTELLIGENCE_SYSTEM_ARCHITECTURE.md)
|
||||
**The Technical Deep Dive** - Implementation details
|
||||
|
||||
**What's inside:**
|
||||
- Complete system architecture (4 layers)
|
||||
- File system structure
|
||||
- Component details (6 major components)
|
||||
- Python code examples and algorithms
|
||||
- Performance considerations
|
||||
- Security and design trade-offs
|
||||
|
||||
**Read this if you want:**
|
||||
- Technical implementation details
|
||||
- Code-level understanding
|
||||
- Architecture decisions explained
|
||||
|
||||
**Size:** 35 pages, ~12K words, lots of code
|
||||
|
||||
---
|
||||
|
||||
### 3. [INTELLIGENCE_SYSTEM_RESEARCH.md](INTELLIGENCE_SYSTEM_RESEARCH.md)
|
||||
**The Research Guide** - Areas to explore
|
||||
|
||||
**What's inside:**
|
||||
- 10 research topics to investigate
|
||||
- 5 experimental ideas
|
||||
- Evaluation criteria and benchmarks
|
||||
- Success metrics
|
||||
- Open questions
|
||||
|
||||
**Read this if you want:**
|
||||
- What to research before building
|
||||
- Experimental features to try
|
||||
- How to evaluate success
|
||||
|
||||
**Size:** 25 pages, ~8K words
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Quick Start Guide
|
||||
|
||||
**If you have 5 minutes:**
|
||||
Read the "Vision" section in SKILL_INTELLIGENCE_SYSTEM.md
|
||||
|
||||
**If you have 30 minutes:**
|
||||
1. Read the "System Overview" in all 3 docs
|
||||
2. Skim the Phase 1 milestones in SKILL_INTELLIGENCE_SYSTEM.md
|
||||
3. Look at code examples in INTELLIGENCE_SYSTEM_ARCHITECTURE.md
|
||||
|
||||
**If you have 2 hours:**
|
||||
Read SKILL_INTELLIGENCE_SYSTEM.md front-to-back for complete understanding
|
||||
|
||||
**If you want to contribute:**
|
||||
1. Read all 3 docs
|
||||
2. Pick a research topic from INTELLIGENCE_SYSTEM_RESEARCH.md
|
||||
3. Run experiments, fill in findings
|
||||
4. Open a PR with results
|
||||
|
||||
---
|
||||
|
||||
## 🗺️ Development Phases Summary
|
||||
|
||||
### Phase 0: Research & Validation (2-3 weeks) - CURRENT
|
||||
- Validate core assumptions
|
||||
- Design architecture
|
||||
- Research clustering algorithms
|
||||
- Define config schema
|
||||
|
||||
**Status:** ✅ Documentation complete, ready for research
|
||||
|
||||
---
|
||||
|
||||
### Phase 1: Git-Based Auto-Generation (3-4 weeks)
|
||||
Auto-generate skills when branches merge
|
||||
|
||||
**Deliverables:**
|
||||
- `skill-seekers init-project` command
|
||||
- Git hook integration
|
||||
- Basic skill regeneration
|
||||
- Config schema v1.0
|
||||
|
||||
**Timeline:** After Phase 0 research complete
|
||||
|
||||
---
|
||||
|
||||
### Phase 2: Tech Stack Detection & Library Skills (2-3 weeks)
|
||||
Auto-detect frameworks and download library skills
|
||||
|
||||
**Deliverables:**
|
||||
- Tech stack detector (FastAPI, React, etc.)
|
||||
- Library skill downloader
|
||||
- Config schema v2.0
|
||||
|
||||
**Timeline:** After Phase 1 complete
|
||||
|
||||
---
|
||||
|
||||
### Phase 3: Modular Skill Splitting (3-4 weeks)
|
||||
Split codebase into focused modular skills
|
||||
|
||||
**Deliverables:**
|
||||
- Module configuration system
|
||||
- Modular skill generator
|
||||
- Config schema v3.0
|
||||
|
||||
**Timeline:** After Phase 2 complete
|
||||
|
||||
---
|
||||
|
||||
### Phase 4: Import-Based Clustering (2-3 weeks)
|
||||
Load only relevant skills based on imports
|
||||
|
||||
**Deliverables:**
|
||||
- Import analyzer (AST-based)
|
||||
- Claude Code plugin
|
||||
- File open handler
|
||||
|
||||
**Timeline:** After Phase 3 complete
|
||||
|
||||
---
|
||||
|
||||
### Phase 5: Embedding-Based Clustering (3-4 weeks) - EXPERIMENTAL
|
||||
Smarter clustering using semantic similarity
|
||||
|
||||
**Deliverables:**
|
||||
- Embedding engine
|
||||
- Hybrid clustering (import + embedding)
|
||||
- Experimental features
|
||||
|
||||
**Timeline:** After Phase 4 complete
|
||||
|
||||
---
|
||||
|
||||
## 📊 Key Metrics & Goals
|
||||
|
||||
### Technical Goals
|
||||
- **Import accuracy:** >85% precision
|
||||
- **Clustering F1-score:** >85%
|
||||
- **Regeneration time:** <5 minutes
|
||||
- **Context usage:** <150K tokens (leave room for code)
|
||||
|
||||
### User Experience Goals
|
||||
- **Ease of use:** >8/10 rating
|
||||
- **Usefulness:** >8/10 rating
|
||||
- **Trust:** >8/10 rating
|
||||
|
||||
### Business Goals
|
||||
- **Target audience:** Individual open source developers
|
||||
- **Adoption:** >100 active users in first 6 months
|
||||
- **Community:** >10 contributors
|
||||
|
||||
---
|
||||
|
||||
## 🎯 What Makes This Different?
|
||||
|
||||
### vs GitHub Copilot
|
||||
- **Copilot:** IDE-only, no skill concept, no codebase structure
|
||||
- **This:** Structured knowledge, auto-updates, context-aware clustering
|
||||
|
||||
### vs Cursor
|
||||
- **Cursor:** Codebase-aware but unstructured, no auto-updates
|
||||
- **This:** Structured skills, modular, git-based updates
|
||||
|
||||
### vs RAG Systems
|
||||
- **RAG:** General purpose, manual maintenance
|
||||
- **This:** Code-specific, auto-maintaining, git-integrated
|
||||
|
||||
**Our edge:** Structured + Automated + Context-Aware
|
||||
|
||||
---
|
||||
|
||||
## 🔬 Research Priorities
|
||||
|
||||
Before building Phase 1, research these:
|
||||
|
||||
**Critical (Must Do):**
|
||||
1. **Import Analysis Accuracy** - Does AST parsing work well enough?
|
||||
2. **Git Hook Performance** - Can we regenerate in <5 minutes?
|
||||
3. **Skill Granularity** - What's the right size for skills?
|
||||
|
||||
**Important (Should Do):**
|
||||
4. **Embedding Model Selection** - Which model is best?
|
||||
5. **Clustering Strategy** - Import vs embedding vs hybrid?
|
||||
|
||||
**Nice to Have:**
|
||||
6. Library skill quality
|
||||
7. Multi-language support
|
||||
8. Context window management
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Next Steps
|
||||
|
||||
### Immediate (This Week)
|
||||
1. ✅ Review these documents
|
||||
2. ✅ Study the architecture
|
||||
3. ✅ Identify questions and concerns
|
||||
4. ⏳ Plan Phase 0 research experiments
|
||||
|
||||
### Short Term (Next 2-3 Weeks)
|
||||
1. Conduct Phase 0 research
|
||||
2. Run experiments from INTELLIGENCE_SYSTEM_RESEARCH.md
|
||||
3. Fill in findings
|
||||
4. Refine architecture based on results
|
||||
|
||||
### Medium Term (Month 2-3)
|
||||
1. Build Phase 1 POC
|
||||
2. Dogfood on skill-seekers
|
||||
3. Iterate based on learnings
|
||||
4. Decide: continue to Phase 2 or pivot?
|
||||
|
||||
### Long Term (6-12 months)
|
||||
1. Complete all 5 phases
|
||||
2. Launch to community
|
||||
3. Gather feedback
|
||||
4. Iterate and improve
|
||||
|
||||
---
|
||||
|
||||
## 🤝 How to Contribute
|
||||
|
||||
### During Research Phase (Current)
|
||||
1. Pick a research topic from INTELLIGENCE_SYSTEM_RESEARCH.md
|
||||
2. Run experiments
|
||||
3. Document findings
|
||||
4. Open PR with results
|
||||
|
||||
### During Implementation (Future)
|
||||
1. Pick a milestone from SKILL_INTELLIGENCE_SYSTEM.md
|
||||
2. Implement feature
|
||||
3. Write tests
|
||||
4. Open PR
|
||||
|
||||
### Always
|
||||
- Ask questions (open issues)
|
||||
- Suggest improvements (open discussions)
|
||||
- Report bugs (when we have code)
|
||||
|
||||
---
|
||||
|
||||
## 📝 Document Status
|
||||
|
||||
| Document | Status | Completeness | Needs Review |
|
||||
|----------|--------|--------------|--------------|
|
||||
| SKILL_INTELLIGENCE_SYSTEM.md | ✅ Complete | 100% | Yes |
|
||||
| INTELLIGENCE_SYSTEM_ARCHITECTURE.md | ✅ Complete | 100% | Yes |
|
||||
| INTELLIGENCE_SYSTEM_RESEARCH.md | ✅ Complete | 100% | Yes |
|
||||
| README.md (this file) | ✅ Complete | 100% | Yes |
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Related Resources
|
||||
|
||||
### Existing Features
|
||||
- **C3.x Codebase Analysis:** Pattern detection, test extraction, architecture analysis
|
||||
- **Bootstrap Skill:** Self-documentation system for skill-seekers
|
||||
- **Platform Adaptors:** Multi-platform support (Claude, Gemini, OpenAI, Markdown)
|
||||
|
||||
### Related Documentation
|
||||
- [docs/features/BOOTSTRAP_SKILL.md](../features/BOOTSTRAP_SKILL.md) - Bootstrap skill feature
|
||||
- [docs/features/BOOTSTRAP_SKILL_TECHNICAL.md](../features/BOOTSTRAP_SKILL_TECHNICAL.md) - Technical deep dive
|
||||
- [docs/features/PATTERN_DETECTION.md](../features/PATTERN_DETECTION.md) - C3.1 pattern detection
|
||||
|
||||
### External References
|
||||
- Claude Code Plugin System (when available)
|
||||
- sentence-transformers (embedding models)
|
||||
- AST parsing (Python, JavaScript)
|
||||
|
||||
---
|
||||
|
||||
## 💬 Questions?
|
||||
|
||||
**Architecture questions:** See INTELLIGENCE_SYSTEM_ARCHITECTURE.md
|
||||
**Timeline questions:** See SKILL_INTELLIGENCE_SYSTEM.md
|
||||
**Research questions:** See INTELLIGENCE_SYSTEM_RESEARCH.md
|
||||
**Other questions:** Open an issue on GitHub
|
||||
|
||||
---
|
||||
|
||||
## 🎓 Learning Path
|
||||
|
||||
**For Product Managers:**
|
||||
→ Read: SKILL_INTELLIGENCE_SYSTEM.md (roadmap)
|
||||
→ Focus: Vision, phases, success metrics
|
||||
|
||||
**For Developers:**
|
||||
→ Read: INTELLIGENCE_SYSTEM_ARCHITECTURE.md (technical)
|
||||
→ Focus: Code examples, components, algorithms
|
||||
|
||||
**For Researchers:**
|
||||
→ Read: INTELLIGENCE_SYSTEM_RESEARCH.md (experiments)
|
||||
→ Focus: Research topics, evaluation criteria
|
||||
|
||||
**For Contributors:**
|
||||
→ Read: All three documents
|
||||
→ Start: Pick a research topic, run experiments
|
||||
|
||||
---
|
||||
|
||||
**Version:** 1.0
|
||||
**Status:** Documentation Complete, Ready for Research
|
||||
**Next:** Begin Phase 0 research experiments
|
||||
**Owner:** Yusuf Karaaslan
|
||||
|
||||
---
|
||||
|
||||
_These documents are living documents - they will evolve as we learn and iterate._
|
||||
Reference in New Issue
Block a user