Antoine/Atomizer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Major documentation overhaul - restructure folders, update tagline, add Getting Started guide

Browse Source 
- Restructure docs/ folder (remove numeric prefixes):
  - 04_USER_GUIDES -> guides/
  - 05_API_REFERENCE -> api/
  - 06_PHYSICS -> physics/
  - 07_DEVELOPMENT -> development/
  - 08_ARCHIVE -> archive/
  - 09_DIAGRAMS -> diagrams/

- Replace tagline 'Talk, don't click' with 'LLM-driven optimization framework' in 9 files

- Create comprehensive docs/GETTING_STARTED.md:
  - Prerequisites and quick setup
  - Project structure overview
  - First study tutorial (Claude or manual)
  - Dashboard usage guide
  - Neural acceleration introduction

- Rewrite docs/00_INDEX.md with correct paths and modern structure

- Archive obsolete files:
  - 01_PROTOCOLS.md -> archive/historical/01_PROTOCOLS_legacy.md
  - 03_GETTING_STARTED.md -> archive/historical/
  - ATOMIZER_PODCAST_BRIEFING.md -> archive/marketing/

- Update timestamps to 2026-01-20 across all key files

- Update .gitignore to exclude docs/generated/

- Version bump: ATOMIZER_CONTEXT v1.8 -> v2.0
This commit is contained in:
Anto01
2026-01-20 10:03:45 -05:00
parent 37f73cc2be
commit ea437d360e
103 changed files with 8980 additions and 327 deletions
Download Patch File Download Diff File Expand all files Collapse all files

445
docs/00_INDEX.md
View File

@@ -1,9 +1,7 @@
# Atomizer Documentation Index
**Welcome to the Atomizer documentation!** This index provides a structured navigation hub for all documentation resources.
**Last Updated**: 2025-11-25
**Project Version**: 0.95.0 (95% complete - Neural Integration Complete!)
**Last Updated**: 2026-01-20
**Project Version**: 1.0.0 (AtomizerSpec v2.0 - Full LLM Integration)
---
@@ -11,361 +9,212 @@
New to Atomizer? Start here:
1. **[README.md](../README.md)** - Project overview, philosophy, and quick start guide
2. **[Getting Started Tutorial](HOW_TO_EXTEND_OPTIMIZATION.md)** - Create your first optimization study
3. **[Neural Features Guide](NEURAL_FEATURES_COMPLETE.md)** - Neural network acceleration (NEW!)
4. **[Example Studies](../studies/)** - Working examples (UAV arm with neural, bracket)
1. **[README.md](../README.md)** - Project overview and philosophy
2. **[Getting Started](GETTING_STARTED.md)** - Installation, first study, dashboard
3. **[Protocol System](protocols/README.md)** - How Atomizer is organized
4. **[Example Studies](../studies/)** - Working examples
---
## Documentation Structure
### 🧠 Neural Network Acceleration (NEW!)
### Core Documentation
**Core Neural Documentation**:
- **[NEURAL_FEATURES_COMPLETE.md](NEURAL_FEATURES_COMPLETE.md)** - Complete guide to all neural features
- **[NEURAL_WORKFLOW_TUTORIAL.md](NEURAL_WORKFLOW_TUTORIAL.md)** - Step-by-step: data → training → optimization
- **[GNN_ARCHITECTURE.md](GNN_ARCHITECTURE.md)** - Technical deep-dive into GNN models
- **[PHYSICS_LOSS_GUIDE.md](PHYSICS_LOSS_GUIDE.md)** - Loss function selection guide
| Document | Purpose |
|----------|---------|
| **[GETTING_STARTED.md](GETTING_STARTED.md)** | Setup, first study, dashboard basics |
| **[ARCHITECTURE.md](ARCHITECTURE.md)** | System architecture, hooks, data flow |
| **[protocols/README.md](protocols/README.md)** | Protocol Operating System overview |
**Integration Documentation**:
- **[ATOMIZER_FIELD_INTEGRATION_PLAN.md](ATOMIZER_FIELD_INTEGRATION_PLAN.md)** - Integration roadmap (COMPLETE)
- **[ATOMIZER_FIELD_NEURAL_OPTIMIZATION_GUIDE.md](ATOMIZER_FIELD_NEURAL_OPTIMIZATION_GUIDE.md)** - API reference
### Protocol System
**Quick Commands**:
```bash
# Run neural-accelerated optimization
python run_optimization.py --trials 5000 --use-neural
The Protocol Operating System (POS) provides structured workflows:
# Train new model
cd atomizer-field && python train_parametric.py --epochs 200
```
protocols/
├── README.md # Protocol system overview
├── operations/ # How-to guides (OP_01-08)
│ ├── OP_01_CREATE_STUDY.md
│ ├── OP_02_RUN_OPTIMIZATION.md
│ ├── OP_03_MONITOR_PROGRESS.md
│ ├── OP_04_ANALYZE_RESULTS.md
│ ├── OP_05_EXPORT_TRAINING_DATA.md
│ ├── OP_06_TROUBLESHOOT.md
│ ├── OP_07_DISK_OPTIMIZATION.md
│ └── OP_08_GENERATE_REPORT.md
├── system/ # Technical specifications (SYS_10-18)
│ ├── SYS_10_IMSO.md # Intelligent optimization
│ ├── SYS_11_MULTI_OBJECTIVE.md
│ ├── SYS_12_EXTRACTOR_LIBRARY.md
│ ├── SYS_13_DASHBOARD_TRACKING.md
│ ├── SYS_14_NEURAL_ACCELERATION.md
│ ├── SYS_15_METHOD_SELECTOR.md
│ ├── SYS_16_SELF_AWARE_TURBO.md
│ ├── SYS_17_STUDY_INSIGHTS.md
│ └── SYS_18_CONTEXT_ENGINEERING.md
└── extensions/ # Extensibility (EXT_01-04)
├── EXT_01_CREATE_EXTRACTOR.md
├── EXT_02_CREATE_HOOK.md
├── EXT_03_CREATE_PROTOCOL.md
└── EXT_04_CREATE_SKILL.md
```
### 📋 01. Core Specifications
### User Guides
**[PROTOCOLS.md](PROTOCOLS.md)** - Master protocol specifications (ALL PROTOCOLS IN ONE PLACE)
- Protocol 10: Intelligent Multi-Strategy Optimization (IMSO)
- Protocol 11: Multi-Objective Support (MANDATORY for all components)
- Protocol 13: Real-Time Dashboard Tracking
Located in `guides/`:
**Individual Protocol Documents** (detailed specifications):
- [PROTOCOL_10_IMSO.md](PROTOCOL_10_IMSO.md) - Adaptive characterization, landscape analysis
- [PROTOCOL_10_V2_IMPLEMENTATION.md](PROTOCOL_10_V2_IMPLEMENTATION.md) - Implementation summary
- [PROTOCOL_10_V2_FIXES.md](PROTOCOL_10_V2_FIXES.md) - Bug fixes and improvements
- [PROTOCOL_11_MULTI_OBJECTIVE_SUPPORT.md](PROTOCOL_11_MULTI_OBJECTIVE_SUPPORT.md) - Multi-objective requirements
- [FIX_SUMMARY_PROTOCOL_11.md](FIX_SUMMARY_PROTOCOL_11.md) - Protocol 11 bug fixes
- [PROTOCOL_13_DASHBOARD.md](PROTOCOL_13_DASHBOARD.md) - Dashboard implementation complete spec
| Guide | Purpose |
|-------|---------|
| **[CANVAS.md](guides/CANVAS.md)** | Visual study builder (AtomizerSpec v2.0) |
| **[DASHBOARD.md](guides/DASHBOARD.md)** | Dashboard overview and features |
| **[NEURAL_FEATURES_COMPLETE.md](guides/NEURAL_FEATURES_COMPLETE.md)** | Neural acceleration guide |
| **[NEURAL_WORKFLOW_TUTORIAL.md](guides/NEURAL_WORKFLOW_TUTORIAL.md)** | Data → Training → Optimization |
| **[hybrid_mode.md](guides/hybrid_mode.md)** | Hybrid FEA/NN optimization |
| **[TRAINING_DATA_EXPORT_GUIDE.md](guides/TRAINING_DATA_EXPORT_GUIDE.md)** | Exporting data for neural training |
### 🏗️ 02. Architecture & Design
### API Reference
**Visual Architecture** (🆕 Comprehensive Diagrams):
- [**Architecture Overview**](09_DIAGRAMS/architecture_overview.md) - Complete system architecture with Mermaid diagrams
- High-level system architecture
- Component interactions
- Data flow diagrams
- Philosophy and design principles
- Technology stack
- [**Protocol Workflows**](09_DIAGRAMS/protocol_workflows.md) - Detailed protocol execution flows
- Protocol 10: IMSO workflow
- Protocol 11: Multi-objective decision trees
- Protocol 13: Real-time tracking
- LLM-assisted workflow (Hybrid Mode)
- All protocols integrated
Located in `api/`:
**System Architecture**:
- [HOOK_ARCHITECTURE.md](HOOK_ARCHITECTURE.md) - Plugin system and lifecycle hooks
- [NX_SESSION_MANAGEMENT.md](NX_SESSION_MANAGEMENT.md) - NX Nastran integration details
- [SYSTEM_CONFIGURATION.md](SYSTEM_CONFIGURATION.md) - Configuration format and options
| Document | Purpose |
|----------|---------|
| **[system_configuration.md](api/system_configuration.md)** | Configuration format reference |
| **[nx_integration.md](api/nx_integration.md)** | NX Open API integration |
| **[GNN_ARCHITECTURE.md](api/GNN_ARCHITECTURE.md)** | Graph Neural Network details |
| **[NXOPEN_RESOURCES.md](api/NXOPEN_RESOURCES.md)** | NX Open documentation resources |
**Extractors & Data Flow**:
- [HOW_TO_EXTEND_OPTIMIZATION.md](HOW_TO_EXTEND_OPTIMIZATION.md) - Unified extractor library (Protocol 12)
### Physics Documentation
### 📊 03. Dashboard
Located in `physics/`:
**Dashboard Documentation**:
- [DASHBOARD_MASTER_PLAN.md](DASHBOARD_MASTER_PLAN.md) - Complete 3-page architecture blueprint
- [DASHBOARD_REACT_IMPLEMENTATION.md](DASHBOARD_REACT_IMPLEMENTATION.md) - React frontend implementation guide
- [DASHBOARD_IMPLEMENTATION_STATUS.md](DASHBOARD_IMPLEMENTATION_STATUS.md) - Current progress and testing
- [DASHBOARD_SESSION_SUMMARY.md](DASHBOARD_SESSION_SUMMARY.md) - Features and usage summary
| Document | Purpose |
|----------|---------|
| **[ZERNIKE_FUNDAMENTALS.md](physics/ZERNIKE_FUNDAMENTALS.md)** | Zernike polynomial basics |
| **[ZERNIKE_OPD_METHOD.md](physics/ZERNIKE_OPD_METHOD.md)** | OPD method for mirror optimization |
**Quick Commands**:
```bash
# Start backend (port 8000)
cd atomizer-dashboard/backend && python -m uvicorn api.main:app --reload --port 8000
### Development
# Start frontend (port 3001)
cd atomizer-dashboard/frontend && npm run dev
```
Located in `development/`:
### 🔧 04. Development
| Document | Purpose |
|----------|---------|
| **[DEVELOPMENT_GUIDANCE.md](development/DEVELOPMENT_GUIDANCE.md)** | Development guidelines |
| **[DEVELOPMENT_ROADMAP.md](development/DEVELOPMENT_ROADMAP.md)** | Future plans |
| **[Philosophy.md](development/Philosophy.md)** | Design philosophy |
**For Contributors**:
- [../DEVELOPMENT.md](../DEVELOPMENT.md) - Development guide, workflow, testing
- [TODAY_PLAN_NOV18.md](TODAY_PLAN_NOV18.md) - Daily development planning example
- [LESSONS_LEARNED.md](LESSONS_LEARNED.md) - Lessons from development sessions
### Diagrams
**Phase Planning**:
- [PHASE_3_1_COMPLETION_SUMMARY.md](PHASE_3_1_COMPLETION_SUMMARY.md) - Phase 3.1 completion
- [PHASE_3_2_INTEGRATION_PLAN.md](PHASE_3_2_INTEGRATION_PLAN.md) - Current phase plan
Located in `diagrams/`:
### 📖 05. User Guides
**Creating & Running Studies**:
- [HOW_TO_EXTEND_OPTIMIZATION.md](HOW_TO_EXTEND_OPTIMIZATION.md) - Complete guide
- Creating custom extractors
- Defining objectives
- Setting up design variables
- Configuring constraints
**Using the Dashboard**:
- Start with [DASHBOARD_SESSION_SUMMARY.md](DASHBOARD_SESSION_SUMMARY.md)
- See [DASHBOARD_MASTER_PLAN.md](DASHBOARD_MASTER_PLAN.md) for full capabilities
**Multi-Objective Optimization**:
- Read [PROTOCOL_11_MULTI_OBJECTIVE_SUPPORT.md](PROTOCOL_11_MULTI_OBJECTIVE_SUPPORT.md)
- Check example: `studies/bracket_stiffness_optimization_V3/`
### 🔬 06. Advanced Topics
**Intelligent Optimization (Protocol 10)**:
- [PROTOCOL_10_IMSO.md](PROTOCOL_10_IMSO.md) - How it works
- [PROTOCOL_10_V2_IMPLEMENTATION.md](PROTOCOL_10_V2_IMPLEMENTATION.md) - Implementation details
- [PROTOCOL_10_V2_FIXES.md](PROTOCOL_10_V2_FIXES.md) - Bug fixes and improvements
**LLM Integration** (Hybrid Mode):
- [HYBRID_MODE_GUIDE.md](HYBRID_MODE_GUIDE.md) - Using LLM-assisted workflows
**NX Integration**:
- [NX_SESSION_MANAGEMENT.md](NX_SESSION_MANAGEMENT.md) - Session handling, solving, extraction
- [NASTRAN_VISUALIZATION_RESEARCH.md](NASTRAN_VISUALIZATION_RESEARCH.md) - Visualizing OP2/BDF results with pyNastran + PyVista
### 📚 07. Session Summaries & Historical
**Recent Sessions** (Nov 2025):
- [GOOD_MORNING_NOV18.md](GOOD_MORNING_NOV18.md) - Morning summary Nov 18
- [DASHBOARD_SESSION_SUMMARY.md](DASHBOARD_SESSION_SUMMARY.md) - Dashboard completion
- [PROTOCOL_13_DASHBOARD.md](PROTOCOL_13_DASHBOARD.md) - Protocol 13 summary
**Historical Documents** (archived for reference):
- Various session summaries in docs/ folder
- Phase completion documents
### 🎨 09. Visual Diagrams
**Comprehensive Visual Documentation**:
- [**Diagram Index**](09_DIAGRAMS/00_INDEX.md) - All visual documentation hub
- [**Architecture Overview**](09_DIAGRAMS/architecture_overview.md) - System architecture diagrams
- [**Protocol Workflows**](09_DIAGRAMS/protocol_workflows.md) - Protocol execution flows
**Viewing Diagrams**:
- Render automatically in GitHub and VS Code (with Markdown Preview Mermaid extension)
- Copy to https://mermaid.live/ for online viewing
- Supported by MkDocs, Docusaurus, and most documentation generators
| Document | Purpose |
|----------|---------|
| **[architecture_overview.md](diagrams/architecture_overview.md)** | System architecture diagrams |
| **[protocol_workflows.md](diagrams/protocol_workflows.md)** | Protocol execution flows |
---
## Documentation by Role
## Documentation by Task
### For New Users
### Creating Studies
Start here for a guided learning path:
1. **[GETTING_STARTED.md](GETTING_STARTED.md)** - First study tutorial
2. **[OP_01_CREATE_STUDY.md](protocols/operations/OP_01_CREATE_STUDY.md)** - Detailed creation protocol
3. **[guides/CANVAS.md](guides/CANVAS.md)** - Visual study builder
1. Read [../README.md](../README.md) - Understand the project
2. Review [PROTOCOLS.md](PROTOCOLS.md) - Learn about the architecture
3. Try [HOW_TO_EXTEND_OPTIMIZATION.md](HOW_TO_EXTEND_OPTIMIZATION.md) - Build your first study
4. Explore dashboard with [DASHBOARD_SESSION_SUMMARY.md](DASHBOARD_SESSION_SUMMARY.md)
### Running Optimizations
### For Developers
1. **[OP_02_RUN_OPTIMIZATION.md](protocols/operations/OP_02_RUN_OPTIMIZATION.md)** - Run protocol
2. **[SYS_10_IMSO.md](protocols/system/SYS_10_IMSO.md)** - Intelligent optimization
3. **[SYS_15_METHOD_SELECTOR.md](protocols/system/SYS_15_METHOD_SELECTOR.md)** - Method selection
Contributing to Atomizer:
### Neural Acceleration
1. [../DEVELOPMENT.md](../DEVELOPMENT.md) - Development workflow and guidelines
2. [PROTOCOLS.md](PROTOCOLS.md) - Understand protocol-based architecture
3. [HOOK_ARCHITECTURE.md](HOOK_ARCHITECTURE.md) - Plugin system internals
4. [HOW_TO_EXTEND_OPTIMIZATION.md](HOW_TO_EXTEND_OPTIMIZATION.md) - Extractor library details
1. **[guides/NEURAL_FEATURES_COMPLETE.md](guides/NEURAL_FEATURES_COMPLETE.md)** - Overview
2. **[SYS_14_NEURAL_ACCELERATION.md](protocols/system/SYS_14_NEURAL_ACCELERATION.md)** - Technical spec
3. **[guides/NEURAL_WORKFLOW_TUTORIAL.md](guides/NEURAL_WORKFLOW_TUTORIAL.md)** - Step-by-step
### For Researchers
### Analyzing Results
Using Atomizer for research:
1. **[OP_04_ANALYZE_RESULTS.md](protocols/operations/OP_04_ANALYZE_RESULTS.md)** - Analysis protocol
2. **[SYS_17_STUDY_INSIGHTS.md](protocols/system/SYS_17_STUDY_INSIGHTS.md)** - Physics visualizations
1. [PROTOCOL_10_IMSO.md](PROTOCOL_10_IMSO.md) - Intelligent optimization algorithms
2. [PROTOCOL_11_MULTI_OBJECTIVE_SUPPORT.md](PROTOCOL_11_MULTI_OBJECTIVE_SUPPORT.md) - Multi-objective capabilities
3. [DASHBOARD_MASTER_PLAN.md](DASHBOARD_MASTER_PLAN.md) - Visualization and analysis tools
4. Example studies in `studies/` folder
### Troubleshooting
1. **[OP_06_TROUBLESHOOT.md](protocols/operations/OP_06_TROUBLESHOOT.md)** - Troubleshooting guide
2. **[GETTING_STARTED.md#troubleshooting](GETTING_STARTED.md#troubleshooting)** - Common issues
---
## Protocol Quick Reference
## Quick Reference
| Protocol | Name | Status | Priority | Version |
|----------|------|--------|----------|---------|
| **10** | Intelligent Multi-Strategy Optimization | ✅ Complete | P0 | v2.1 |
| **11** | Multi-Objective Support | ✅ Complete | P0 (MANDATORY) | v1.0 |
| **13** | Real-Time Dashboard Tracking | ✅ Complete | P1 | v1.0 |
| **Neural** | GNN Acceleration (AtomizerField) | ✅ Complete | P0 | v1.0 |
### Protocol Summary
**See [PROTOCOLS.md](PROTOCOLS.md) for complete specifications.**
| Protocol | Name | Purpose |
|----------|------|---------|
| **OP_01** | Create Study | Study creation workflow |
| **OP_02** | Run Optimization | Execution workflow |
| **OP_03** | Monitor Progress | Real-time monitoring |
| **OP_04** | Analyze Results | Results analysis |
| **OP_06** | Troubleshoot | Debugging issues |
| **SYS_10** | IMSO | Intelligent optimization |
| **SYS_12** | Extractors | Physics extraction library |
| **SYS_14** | Neural | Neural network acceleration |
## Neural Features Quick Reference
| Feature | Status | Performance |
|---------|--------|-------------|
| **Parametric GNN** | ✅ Production | 4.5ms inference, 2,200x speedup |
| **Field Predictor GNN** | ✅ Production | 50ms inference, full field output |
| **Physics-Informed Loss** | ✅ Production | <5% prediction error |
| **Hybrid Optimization** | ✅ Production | 97% NN usage rate |
| **Uncertainty Quantification** | ✅ Production | Ensemble-based confidence |
| **Training Pipeline** | ✅ Production | BDF/OP2 → GNN → Deploy |
**See [NEURAL_FEATURES_COMPLETE.md](NEURAL_FEATURES_COMPLETE.md) for details.**
---
## Common Tasks
### Running an Optimization
### Essential Commands
```bash
# Navigate to study
cd studies/my_study
# Activate environment
conda activate atomizer
# Run optimization
python run_optimization.py --trials 50
python run_optimization.py --start --trials 50
# View in dashboard
# Open http://localhost:3001 and select study
# Resume interrupted run
python run_optimization.py --start --resume
# Start dashboard
python launch_dashboard.py
# Neural turbo mode
python run_nn_optimization.py --turbo --nn-trials 5000
```
### Creating a New Study
### Key Extractors
```bash
# Use template (recommended)
python create_study.py --name my_study --model path/to/model.prt
| ID | Physics | Function |
|----|---------|----------|
| E1 | Displacement | `extract_displacement()` |
| E2 | Frequency | `extract_frequency()` |
| E3 | Stress | `extract_solid_stress()` |
| E4 | Mass (BDF) | `extract_mass_from_bdf()` |
| E5 | Mass (CAD) | `extract_mass_from_expression()` |
| E22 | Zernike OPD | `extract_zernike_opd()` |
# Or manually
mkdir -p studies/my_study/1_setup/model
# Copy model files
# Edit optimization_config.json
# Create run_optimization.py
```
### Checking Protocol 10 Intelligence Reports
```bash
# View characterization progress
cat studies/my_study/2_results/intelligent_optimizer/characterization_progress.json
# View final intelligence report
cat studies/my_study/2_results/intelligent_optimizer/intelligence_report.json
# View strategy transitions
cat studies/my_study/2_results/intelligent_optimizer/strategy_transitions.json
```
Full catalog: [SYS_12_EXTRACTOR_LIBRARY.md](protocols/system/SYS_12_EXTRACTOR_LIBRARY.md)
---
## File Organization
## Archive
```
Atomizer/
├── README.md # Project overview
├── DEVELOPMENT.md # Development guide
├── docs/
│ ├── 00_INDEX.md # THIS FILE - Documentation hub
│ ├── PROTOCOLS.md # Master protocol specifications
│ ├── PROTOCOL_10_*.md # Protocol 10 detailed docs
│ ├── PROTOCOL_11_*.md # Protocol 11 detailed docs
│ ├── PROTOCOL_13_*.md # Protocol 13 detailed docs
│ ├── DASHBOARD_*.md # Dashboard documentation
│ ├── HOOK_ARCHITECTURE.md # Plugin system
│ ├── NX_SESSION_MANAGEMENT.md # NX integration
│ ├── HOW_TO_EXTEND_OPTIMIZATION.md # User guide
│ └── [session summaries] # Historical documents
├── optimization_engine/ # Core optimization code
├── atomizer-dashboard/ # Dashboard frontend & backend
├── studies/ # Optimization studies
└── examples/ # Example models
```
Historical documents are preserved in `archive/`:
- `archive/historical/` - Legacy documents, old protocols
- `archive/marketing/` - Briefings, presentations
- `archive/session_summaries/` - Past development sessions
---
## Getting Help
## LLM Resources
### Documentation Issues
For Claude/AI integration:
- **Missing information?** Check [PROTOCOLS.md](PROTOCOLS.md) for comprehensive specs
- **Protocol questions?** See individual protocol docs (PROTOCOL_XX_*.md)
- **Dashboard issues?** Check [DASHBOARD_IMPLEMENTATION_STATUS.md](DASHBOARD_IMPLEMENTATION_STATUS.md)
### Technical Issues
- **NX integration problems?** See [NX_SESSION_MANAGEMENT.md](NX_SESSION_MANAGEMENT.md)
- **Multi-objective errors?** Check [PROTOCOL_11_MULTI_OBJECTIVE_SUPPORT.md](PROTOCOL_11_MULTI_OBJECTIVE_SUPPORT.md)
- **Protocol 10 not working?** See [PROTOCOL_10_V2_FIXES.md](PROTOCOL_10_V2_FIXES.md)
### Community
- **GitHub Issues**: https://github.com/yourusername/Atomizer/issues
- **Discussions**: https://github.com/yourusername/Atomizer/discussions
- **Email**: your.email@example.com
| Resource | Purpose |
|----------|---------|
| **[../CLAUDE.md](../CLAUDE.md)** | System instructions |
| **[../.claude/ATOMIZER_CONTEXT.md](../.claude/ATOMIZER_CONTEXT.md)** | Session context |
| **[../.claude/skills/](../.claude/skills/)** | Skill modules |
---
## Document Conventions
### Naming System
Documentation files use numbered prefixes for organization:
- `00_*` - Index and navigation files
- `01_*` - Core specifications (protocols)
- `02_*` - Architecture documentation
- `03_*` - User guides
- Individual protocol docs use descriptive names (PROTOCOL_XX_NAME.md)
### Status Indicators
- ✅ Complete - Fully implemented and tested
- 🔨 In Progress - Active development
- 📋 Planned - Design phase
- ⏳ Pending - Not yet started
### Version Format
- **Major.Minor.Patch** (e.g., v2.1.0)
- **Major**: Breaking changes or architectural redesign
- **Minor**: New features, backward compatible
- **Patch**: Bug fixes
---
## Contributing to Documentation
### Updating Documentation
1. Keep [00_INDEX.md](00_INDEX.md) (this file) up to date with new docs
2. Update [PROTOCOLS.md](PROTOCOLS.md) when adding/modifying protocols
3. Maintain [../DEVELOPMENT.md](../DEVELOPMENT.md) with current status
4. Add session summaries for major development sessions
### Documentation Style
- Use clear, concise language
- Include code examples
- Add diagrams for complex concepts
- Follow Markdown best practices
- Keep table of contents updated
### Review Process
1. Create pull request with documentation changes
2. Ensure cross-references are valid
3. Update index files (this file, PROTOCOLS.md)
4. Check for broken links
---
**Last Updated**: 2025-11-21
**Maintained By**: Atomizer Development Team
**Next Review**: When new protocols or major features are added
For questions about this documentation structure, open an issue on GitHub.
**Last Updated**: 2026-01-20
**Maintained By**: Antoine / Atomaste