1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
# Documentation Index
This document provides a consolidated index of all documentation in the Amari project.
## Getting Started
- [README.md](README.md) - Main project overview and quick start
- [CHANGELOG.md](CHANGELOG.md) - Release notes and version history
- [CONTRIBUTING.md](CONTRIBUTING.md) - Contribution guidelines
## Release and Development
- [Release Process](docs/RELEASE_PROCESS.md) - Complete release workflow and version management
- [Deployment Strategy](docs/development/DEPLOYMENT_STRATEGY.md) - Multi-phase deployment approach
- [NPM Publishing Roadmap](docs/development/NPM_PUBLISHING_ROADMAP.md) - WebAssembly package distribution plan
## Technical Documentation
- [API Naming Convention](docs/technical/API_NAMING_CONVENTION.md) - Standardized naming patterns across all crates
- [Error Handling Design](docs/technical/ERROR_HANDLING_DESIGN.md) - Unified error handling methodology
- [Formal Verification Methodology](docs/technical/FORMAL_VERIFICATION_METHODOLOGY.md) - Property-based testing approach
- [Phantom Types Methodology](docs/technical/PHANTOM_TYPES_METHODOLOGY.md) - Type-level mathematical constraints
## AI Assistant Context
The following documents provide comprehensive context for AI assistants working on the Amari project:
- [Consolidated Context](docs/claude-code/CONSOLIDATED_CONTEXT.md) - **Primary reference** - Complete project context and guidelines
- [Claude Code Features](docs/claude-code/CLAUDE_CODE_FEATURES.md) - Available AI assistant capabilities
- [Project Context](docs/claude-code/PROJECT_CONTEXT.md) - Historical project context document
## Documentation Organization
All documentation has been reorganized into logical directories:
- `docs/` - Main documentation directory
- `claude-code/` - AI assistant context and guidelines
- `technical/` - Technical specifications and methodologies
- `development/` - Development and deployment guides
- Root directory - Essential user-facing documents only
## Quick References
### For Developers
Start with [CONSOLIDATED_CONTEXT.md](docs/claude-code/CONSOLIDATED_CONTEXT.md) for complete project understanding.
### For Contributors
See [CONTRIBUTING.md](CONTRIBUTING.md) and [API_NAMING_CONVENTION.md](docs/technical/API_NAMING_CONVENTION.md).
### For Release Management
Follow [RELEASE_PROCESS.md](docs/RELEASE_PROCESS.md) for version management and publishing.
---
*This index is automatically maintained. Last updated: January 2025*