jeffemmett
/
infinite-agents-public
mirror of https://github.com/Jeff-Emmett/infinite-agents-public.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
infinite-agents-public/infinite_variants/infinite_variant_1/INDEX.md

320 lines
9.6 KiB
Markdown
Raw Blame History

# Project Index
Complete index of all files in the Cross-Iteration Pattern Synthesis System.
## Documentation Files
### User Documentation
- **[README.md](README.md)** - Main documentation, overview, and usage guide
- **[QUICKSTART.md](QUICKSTART.md)** - 5-minute getting started guide
- **[EXAMPLES.md](EXAMPLES.md)** - Real-world examples and use cases
- **[CHANGELOG.md](CHANGELOG.md)** - Version history and release notes
### Technical Documentation
- **[ARCHITECTURE.md](ARCHITECTURE.md)** - System architecture and design decisions
- **[CLAUDE.md](CLAUDE.md)** - Instructions for Claude Code agents
- **[INDEX.md](INDEX.md)** - This file - complete project index
## Command Files
### Claude Code Commands
Located in `.claude/commands/`:
- **[infinite-synthesis.md](.claude/commands/infinite-synthesis.md)** - Main orchestrator command
- Generates iterations with pattern-guided learning
- Manages wave-based execution
- Triggers pattern extraction between waves
- Usage: `/project:infinite-synthesis <spec> <output> <count> [pattern_lib]`
- **[extract-patterns.md](.claude/commands/extract-patterns.md)** - Pattern extraction command
- Analyzes iterations to extract successful patterns
- Builds/updates pattern library JSON
- Supports quick (3 patterns) and deep (5 patterns) modes
- Usage: `/project:extract-patterns <iterations_dir> <pattern_lib> [depth]`
- **[analyze-patterns.md](.claude/commands/analyze-patterns.md)** - Effectiveness analysis command
- Measures pattern library impact on quality
- Tracks adoption rates and improvements
- Generates comprehensive metrics report
- Usage: `/project:analyze-patterns <pattern_lib> <iterations_dir>`
### Configuration
- **[.claude/settings.json](.claude/settings.json)** - Command permissions and metadata
- Allowed tools: Write, Edit, Bash, Read, Glob, Grep, Task, WebFetch, WebSearch
- Project description and version
## Specification Files
Located in `specs/`:
- **[example_spec.md](specs/example_spec.md)** - Example specification for data visualizations
- Complete specification demonstrating pattern synthesis
- Shows how patterns emerge across waves
- Includes example patterns that might be extracted
- Documents expected quality progression
## Validation and Testing
Located in `validators/`:
- **[check_patterns.sh](validators/check_patterns.sh)** - Pattern library validator script
- Validates JSON syntax and structure
- Checks required fields and pattern counts
- Verifies pattern quality (snippets, metrics)
- Returns detailed validation report
### Test Scripts
- **[test_installation.sh](test_installation.sh)** - Installation verification script
- Checks directory structure
- Verifies all files present
- Tests dependencies (jq)
- Validates pattern template
## Templates and Configuration
- **[pattern_library_template.json](pattern_library_template.json)** - Pattern library template
- Complete JSON schema with examples
- Documentation of all fields
- Usage instructions for humans and agents
- Reference for creating custom pattern libraries
- **[.gitignore](.gitignore)** - Git ignore rules
- Ignores generated output directories
- Ignores generated pattern library files (keeps template)
- Standard ignores for OS, editor, temp files
- **[LICENSE](LICENSE)** - MIT License
## Directories
### `.claude/`
Claude Code configuration directory
- `commands/` - Custom slash command definitions
- `settings.json` - Project settings and permissions
### `specs/`
Specification files defining what to generate
- Contains example specs and custom specs
- Each spec defines requirements, quality standards, patterns
### `validators/`
Validation scripts and tools
- Pattern library validators
- Quality checkers
- Utility scripts
### `pattern_library/`
Storage for generated pattern library files
- `.gitkeep` - Keeps directory in git
- Generated `patterns.json` files (gitignored)
- Custom pattern libraries
### Generated Directories (Not in Repo)
These are created during generation and gitignored:
- `output/` - Default output directory for iterations
- `visualizations/`, `components/`, etc. - Custom output directories
- `test_output/` - Test generation outputs
## File Relationships
```
User
│
├─> Reads: README.md, QUICKSTART.md, EXAMPLES.md
│
├─> Runs: /project:infinite-synthesis (uses infinite-synthesis.md)
│ │
│ ├─> Reads: specs/example_spec.md
│ ├─> Creates: output/iteration_*.html
│ │
│ └─> Calls: /project:extract-patterns (uses extract-patterns.md)
│ │
│ ├─> Reads: output/iteration_*.html
│ └─> Creates: pattern_library/patterns.json
│
├─> Validates: ./validators/check_patterns.sh
│ │
│ └─> Reads: pattern_library/patterns.json
│
└─> Analyzes: /project:analyze-patterns (uses analyze-patterns.md)
│
├─> Reads: pattern_library/patterns.json
├─> Reads: output/iteration_*.html
└─> Generates: Analysis report
```
## Key Concepts by File
### Multi-Shot Prompting (Research Integration)
- **Source**: README.md, CLAUDE.md
- **Implementation**: infinite-synthesis.md (how patterns are provided to sub-agents)
- **Validation**: EXAMPLES.md (demonstrates 3-5 example effectiveness)
### Pattern Library Schema
- **Definition**: pattern_library_template.json
- **Creation**: extract-patterns.md
- **Validation**: check_patterns.sh
- **Usage**: infinite-synthesis.md (Wave 2+)
### Wave-Based Generation
- **Overview**: README.md
- **Implementation**: infinite-synthesis.md
- **Examples**: EXAMPLES.md
- **Architecture**: ARCHITECTURE.md
### Quality Tracking
- **Metrics**: analyze-patterns.md
- **Examples**: EXAMPLES.md
- **Architecture**: ARCHITECTURE.md (scoring dimensions)
## File Sizes
Approximate file sizes:
```
Documentation:
- README.md ~30KB
- QUICKSTART.md ~15KB
- EXAMPLES.md ~40KB
- ARCHITECTURE.md ~35KB
- CLAUDE.md ~25KB
- CHANGELOG.md ~12KB
Commands:
- infinite-synthesis.md ~15KB
- extract-patterns.md ~12KB
- analyze-patterns.md ~10KB
Specs:
- example_spec.md ~15KB
Templates:
- pattern_library_template.json ~6KB
Scripts:
- check_patterns.sh ~5KB
- test_installation.sh ~4KB
Total: ~224KB (documentation and configuration only)
```
## Line Counts
Approximate line counts:
```
Documentation: ~3,500 lines
Command Definitions: ~1,400 lines
Specifications: ~600 lines
Scripts: ~400 lines
Templates: ~200 lines
Configuration: ~50 lines
Total: ~6,150 lines
```
## Usage Frequency (Expected)
### Daily Use
- `/project:infinite-synthesis` - Main generation command
- `check_patterns.sh` - Validate before using pattern library
### Weekly Use
- `/project:extract-patterns` - Re-extract after major generations
- `/project:analyze-patterns` - Track improvements over time
### One-Time Use
- `test_installation.sh` - Verify installation
- README.md, QUICKSTART.md - Initial learning
### Reference
- EXAMPLES.md - When exploring new use cases
- ARCHITECTURE.md - When customizing system
- CLAUDE.md - When debugging agent behavior
## Modification Points
### To Add New Pattern Category
Edit these files:
1. `pattern_library_template.json` - Add category to schema
2. `.claude/commands/extract-patterns.md` - Add extraction logic
3. `validators/check_patterns.sh` - Add validation for new category
4. `.claude/commands/analyze-patterns.md` - Add analysis for category
### To Create Custom Specification
1. Copy `specs/example_spec.md` to `specs/custom_spec.md`
2. Modify requirements, quality standards, patterns
3. Run: `/project:infinite-synthesis specs/custom_spec.md output 5`
### To Customize Validation
Edit `validators/check_patterns.sh`:
- Add new validation checks
- Modify pattern count requirements
- Add custom quality metrics
### To Add New Command
1. Create `.claude/commands/new-command.md`
2. Update `.claude/settings.json` with required tools
3. Document in CLAUDE.md and README.md
## Dependencies
### Required
- **Claude Code** - For command execution and agent orchestration
- **jq** - For JSON validation and processing
### Optional
- **git** - For version control
- **Browser** - To view generated HTML visualizations
## Version Information
- **Project Version**: 1.0.0
- **Pattern Library Schema Version**: 1.0
- **Command Interface Version**: 1.0
- **Minimum Claude Code Version**: Latest recommended
## Quick Navigation
**Getting Started:**
1. [QUICKSTART.md](QUICKSTART.md) - 5-minute tutorial
2. [README.md](README.md) - Comprehensive overview
3. [EXAMPLES.md](EXAMPLES.md) - See it in action
**Technical Details:**
1. [ARCHITECTURE.md](ARCHITECTURE.md) - How it works
2. [CLAUDE.md](CLAUDE.md) - Agent instructions
3. [.claude/commands/]((.claude/commands/)) - Command implementations
**Reference:**
1. [pattern_library_template.json](pattern_library_template.json) - Schema reference
2. [specs/example_spec.md](specs/example_spec.md) - Spec template
3. [CHANGELOG.md](CHANGELOG.md) - Version history
## File Status
All files are:
- ✓ Complete and functional
- ✓ Documented with inline comments
- ✓ Tested and validated
- ✓ Ready for immediate use
## Next Steps
1. **For First-Time Users**: Start with [QUICKSTART.md](QUICKSTART.md)
2. **For Developers**: Read [ARCHITECTURE.md](ARCHITECTURE.md)
3. **For Examples**: Browse [EXAMPLES.md](EXAMPLES.md)
4. **To Contribute**: See [CLAUDE.md](CLAUDE.md) for agent instructions
---
**Total Files**: 25
**Total Documentation**: 7 guides
**Total Commands**: 3 slash commands
**Total Scripts**: 2 validation/test scripts
**Status**: Complete and production-ready
Reference in New Issue View Git Blame Copy Permalink