Skip to content

Commit faaa91e

Browse files
authored
docs: add documentation for vcs object design (#49)
- add documentation for vcs object design
1 parent deb227d commit faaa91e

File tree

4 files changed

+646
-8
lines changed

4 files changed

+646
-8
lines changed
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Source Code Lookup Rules
2+
3+
## MANDATORY: Check Local Cache First
4+
5+
When user asks to "look at source code" or examine external project implementations:
6+
7+
**ALWAYS check `.cache/repos/` directory first** before attempting external lookups.
8+
9+
## Workflow
10+
11+
1. **Check local cache**: Look in `.cache/repos/<project-name>/`
12+
2. **If found**: Use local cached version
13+
3. **If not found**: Then attempt external lookup (GitHub API, etc.)
14+
15+
## Examples
16+
17+
- "look at dunamai source code" → Check `.cache/repos/dunamai/` first
18+
- "examine ripgrep implementation" → Check `.cache/repos/ripgrep/` first
19+
- "see how X handles Y" → Check `.cache/repos/X/` first

.dev/00-roadmap.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,8 @@
8080

8181
### Enhanced VCS Support
8282

83-
- [ ] Archive support (`.git_archival.json`)
8483
- [ ] Shallow repository handling
84+
- [ ] Archive support (`.git_archival.json`) - _if requested by users_
8585
- [ ] Multiple VCS systems (Mercurial, SVN)
8686

8787
### Configuration System
@@ -107,8 +107,7 @@ zerv/
107107
├── src/
108108
│ ├── vcs/
109109
│ │ ├── mod.rs # VCS trait and detection
110-
│ │ ├── git.rs # Git implementation
111-
│ │ └── archive.rs # Archive support
110+
│ │ └── git.rs # Git implementation (includes archive support)
112111
│ ├── cli/
113112
│ │ ├── mod.rs # CLI framework
114113
│ │ ├── commands.rs # Command implementations
@@ -180,10 +179,10 @@ zerv version --schema zerv-default --output-format pep440
180179
- Multiple VCS support (Mercurial, SVN, Darcs)
181180
- Advanced configuration system
182181
- Version bumping and manipulation
183-
- Archive format support
184182

185183
**1.0 Features**:
186184

185+
- Archive support (if user demand exists)
187186
- Complete dunamai feature parity
188187
- Performance optimizations
189188
- Comprehensive documentation

0 commit comments

Comments
 (0)