# SuiForge Documentation Index
Complete guide to all SuiForge documentation and resources.
## 📚 Quick Navigation
### For New Users
1. [README.md](README.md) - Start here for overview and installation
2. [QUICKSTART.md](QUICKSTART.md) - Get up and running in 5 minutes
3. [examples/basic-usage.md](examples/basic-usage.md) - Practical examples
### For Developers
1. [BUILD_GUIDE.md](BUILD_GUIDE.md) - Build from source
2. [CONTRIBUTING.md](CONTRIBUTING.md) - Contribution guidelines
3. [ARCHITECTURE.md](ARCHITECTURE.md) - Technical architecture
### For Project Managers
1. [PROJECT_OVERVIEW.md](PROJECT_OVERVIEW.md) - Executive summary
2. [IMPLEMENTATION_SUMMARY.md](IMPLEMENTATION_SUMMARY.md) - What was built
3. [CHANGELOG.md](CHANGELOG.md) - Version history
## 📖 Documentation Structure
### Core Documentation
#### [README.md](README.md)
**Purpose**: Main entry point for all users
**Contents**:
- What is SuiForge
- Why it exists
- Installation instructions
- Command reference
- Quick examples
- Configuration guide
- Best practices
**Read this if**: You're new to SuiForge
---
#### [QUICKSTART.md](QUICKSTART.md)
**Purpose**: Get started in 5 minutes
**Contents**:
- Prerequisites
- Installation steps
- First project creation
- Build, test, deploy workflow
- Next steps
**Read this if**: You want to try SuiForge immediately
---
#### [PROJECT_OVERVIEW.md](PROJECT_OVERVIEW.md)
**Purpose**: High-level project vision and goals
**Contents**:
- Executive summary
- Problem statement
- Solution overview
- Core features
- Technical stack
- Roadmap
- Success metrics
**Read this if**: You want to understand the big picture
---
### Technical Documentation
#### [ARCHITECTURE.md](ARCHITECTURE.md)
**Purpose**: Deep dive into technical design
**Contents**:
- System architecture
- Component design
- Data flow diagrams
- Design decisions
- Module structure
- Performance considerations
- Security considerations
**Read this if**: You want to understand how SuiForge works internally
---
#### [BUILD_GUIDE.md](BUILD_GUIDE.md)
**Purpose**: Complete build and development guide
**Contents**:
- Prerequisites
- Installation methods
- Development setup
- Building from source
- Testing procedures
- Code quality tools
- Debugging tips
- Release process
**Read this if**: You want to build SuiForge from source
---
#### [VISUAL_GUIDE.md](VISUAL_GUIDE.md)
**Purpose**: Visual diagrams and flowcharts
**Contents**:
- System architecture diagrams
- Command flow charts
- Project structure visualization
- Template system overview
- Module library architecture
- SDK generation flow
- Deployment workflow
**Read this if**: You prefer visual learning
---
### Contribution Documentation
#### [CONTRIBUTING.md](CONTRIBUTING.md)
**Purpose**: Guide for contributors
**Contents**:
- Getting started
- Development setup
- Code style guidelines
- Testing requirements
- Pull request process
- Community guidelines
**Read this if**: You want to contribute to SuiForge
---
#### [CHANGELOG.md](CHANGELOG.md)
**Purpose**: Version history and changes
**Contents**:
- Release notes
- New features
- Bug fixes
- Breaking changes
- Upgrade guides
**Read this if**: You want to know what changed between versions
---
### Implementation Documentation
#### [IMPLEMENTATION_SUMMARY.md](IMPLEMENTATION_SUMMARY.md)
**Purpose**: Complete implementation details
**Contents**:
- What was built
- File structure
- Code statistics
- Feature checklist
- Quality metrics
- Production readiness
- Next steps
**Read this if**: You want to know exactly what's implemented
---
### Usage Documentation
#### [examples/basic-usage.md](examples/basic-usage.md)
**Purpose**: Practical usage examples
**Contents**:
- NFT project example
- Token project example
- Using SuiForge modules
- Marketplace example
- Local development workflow
- Multi-module projects
- Deployment examples
- CI/CD integration
- Troubleshooting
**Read this if**: You want to see real-world examples
---
### Module Documentation
#### [modules/README.md](modules/README.md)
**Purpose**: Move modules library documentation
**Contents**:
- Available modules
- Installation instructions
- Usage examples
- API reference
- Contributing guidelines
**Read this if**: You want to use SuiForge Move modules
---
## 🗂️ Documentation by Topic
### Installation & Setup
- [README.md](README.md) - Installation section
- [QUICKSTART.md](QUICKSTART.md) - Complete setup guide
- [BUILD_GUIDE.md](BUILD_GUIDE.md) - Build from source
### Getting Started
- [QUICKSTART.md](QUICKSTART.md) - 5-minute guide
- [examples/basic-usage.md](examples/basic-usage.md) - First project
- [README.md](README.md) - Command reference
### Commands & CLI
- [README.md](README.md) - All commands
- [examples/basic-usage.md](examples/basic-usage.md) - Command examples
- [VISUAL_GUIDE.md](VISUAL_GUIDE.md) - Command flows
### Templates
- [README.md](README.md) - Template overview
- [examples/basic-usage.md](examples/basic-usage.md) - Template usage
- [VISUAL_GUIDE.md](VISUAL_GUIDE.md) - Template system
### Move Modules
- [modules/README.md](modules/README.md) - Module documentation
- [examples/basic-usage.md](examples/basic-usage.md) - Module usage
- [ARCHITECTURE.md](ARCHITECTURE.md) - Module design
### SDK Generation
- [README.md](README.md) - Generate command
- [examples/basic-usage.md](examples/basic-usage.md) - SDK examples
- [ARCHITECTURE.md](ARCHITECTURE.md) - Codegen architecture
### Configuration
- [README.md](README.md) - Configuration guide
- [ARCHITECTURE.md](ARCHITECTURE.md) - Config system
- [VISUAL_GUIDE.md](VISUAL_GUIDE.md) - Config hierarchy
### Deployment
- [README.md](README.md) - Deploy command
- [examples/basic-usage.md](examples/basic-usage.md) - Deployment examples
- [VISUAL_GUIDE.md](VISUAL_GUIDE.md) - Deployment workflow
### Development
- [BUILD_GUIDE.md](BUILD_GUIDE.md) - Development setup
- [CONTRIBUTING.md](CONTRIBUTING.md) - Development workflow
- [ARCHITECTURE.md](ARCHITECTURE.md) - Code structure
### Architecture
- [ARCHITECTURE.md](ARCHITECTURE.md) - Complete architecture
- [VISUAL_GUIDE.md](VISUAL_GUIDE.md) - Visual diagrams
- [PROJECT_OVERVIEW.md](PROJECT_OVERVIEW.md) - High-level design
### Contributing
- [CONTRIBUTING.md](CONTRIBUTING.md) - How to contribute
- [BUILD_GUIDE.md](BUILD_GUIDE.md) - Development setup
- [ARCHITECTURE.md](ARCHITECTURE.md) - Code structure
### Troubleshooting
- [examples/basic-usage.md](examples/basic-usage.md) - Common issues
- [BUILD_GUIDE.md](BUILD_GUIDE.md) - Build problems
- [README.md](README.md) - Support section
## 📊 Documentation Statistics
### Total Documentation
- **Files**: 13 documentation files
- **Lines**: ~6,000+ lines of documentation
- **Topics**: 50+ covered topics
- **Examples**: 20+ code examples
- **Diagrams**: 10+ visual diagrams
### Coverage
- ✅ Installation & Setup
- ✅ Getting Started
- ✅ Command Reference
- ✅ Configuration
- ✅ Templates
- ✅ Move Modules
- ✅ SDK Generation
- ✅ Deployment
- ✅ Architecture
- ✅ Contributing
- ✅ Troubleshooting
- ✅ Examples
## 🎯 Reading Paths
### Path 1: Quick Start (15 minutes)
1. [README.md](README.md) - Overview (5 min)
2. [QUICKSTART.md](QUICKSTART.md) - Setup (5 min)
3. [examples/basic-usage.md](examples/basic-usage.md) - First example (5 min)
### Path 2: Deep Dive (1 hour)
1. [PROJECT_OVERVIEW.md](PROJECT_OVERVIEW.md) - Vision (10 min)
2. [ARCHITECTURE.md](ARCHITECTURE.md) - Design (20 min)
3. [VISUAL_GUIDE.md](VISUAL_GUIDE.md) - Diagrams (10 min)
4. [examples/basic-usage.md](examples/basic-usage.md) - Examples (20 min)
### Path 3: Contributor (2 hours)
1. [CONTRIBUTING.md](CONTRIBUTING.md) - Guidelines (15 min)
2. [BUILD_GUIDE.md](BUILD_GUIDE.md) - Setup (30 min)
3. [ARCHITECTURE.md](ARCHITECTURE.md) - Code structure (45 min)
4. [IMPLEMENTATION_SUMMARY.md](IMPLEMENTATION_SUMMARY.md) - Status (30 min)
### Path 4: User (30 minutes)
1. [QUICKSTART.md](QUICKSTART.md) - Setup (10 min)
2. [README.md](README.md) - Commands (10 min)
3. [examples/basic-usage.md](examples/basic-usage.md) - Examples (10 min)
## 🔍 Search Guide
### Looking for...
**"How do I install SuiForge?"**
→ [README.md](README.md) or [QUICKSTART.md](QUICKSTART.md)
**"How do I create a new project?"**
→ [QUICKSTART.md](QUICKSTART.md) or [examples/basic-usage.md](examples/basic-usage.md)
**"What commands are available?"**
→ [README.md](README.md)
**"How do I use templates?"**
→ [README.md](README.md) or [examples/basic-usage.md](examples/basic-usage.md)
**"How do I deploy to mainnet?"**
→ [README.md](README.md) or [examples/basic-usage.md](examples/basic-usage.md)
**"How do I generate an SDK?"**
→ [README.md](README.md) or [examples/basic-usage.md](examples/basic-usage.md)
**"How does SuiForge work internally?"**
→ [ARCHITECTURE.md](ARCHITECTURE.md) or [VISUAL_GUIDE.md](VISUAL_GUIDE.md)
**"How do I build from source?"**
→ [BUILD_GUIDE.md](BUILD_GUIDE.md)
**"How do I contribute?"**
→ [CONTRIBUTING.md](CONTRIBUTING.md)
**"What Move modules are available?"**
→ [modules/README.md](modules/README.md)
**"What's the project vision?"**
→ [PROJECT_OVERVIEW.md](PROJECT_OVERVIEW.md)
**"What's been implemented?"**
→ [IMPLEMENTATION_SUMMARY.md](IMPLEMENTATION_SUMMARY.md)
**"What changed in the latest version?"**
→ [CHANGELOG.md](CHANGELOG.md)
## 📝 Documentation Maintenance
### Keeping Docs Updated
When making changes to SuiForge:
1. **Code Changes**
- Update [ARCHITECTURE.md](ARCHITECTURE.md) if architecture changes
- Update [IMPLEMENTATION_SUMMARY.md](IMPLEMENTATION_SUMMARY.md) with new features
- Update [CHANGELOG.md](CHANGELOG.md) with changes
2. **New Features**
- Update [README.md](README.md) command reference
- Add examples to [examples/basic-usage.md](examples/basic-usage.md)
- Update [VISUAL_GUIDE.md](VISUAL_GUIDE.md) if needed
3. **Bug Fixes**
- Update [CHANGELOG.md](CHANGELOG.md)
- Update troubleshooting sections
4. **Breaking Changes**
- Update [CHANGELOG.md](CHANGELOG.md)
- Add migration guide
- Update all affected docs
## 🌐 External Resources
### Official Links
- **Website**: https://suiforge.dev (planned)
- **GitHub**: https://github.com/yourusername/suiforge
- **Discord**: https://discord.gg/suiforge
- **Twitter**: @suiforge
### Related Documentation
- **Sui Documentation**: https://docs.sui.io
- **Move Book**: https://move-book.com
- **Rust Book**: https://doc.rust-lang.org/book/
## 💡 Tips for Reading
1. **Start with your goal**: Use the reading paths above
2. **Use search**: Ctrl+F to find specific topics
3. **Follow links**: Documentation is interconnected
4. **Try examples**: Best way to learn is by doing
5. **Ask questions**: Join Discord for help
## 🤝 Improving Documentation
Found an issue or want to improve docs?
1. Open an issue on GitHub
2. Submit a pull request
3. Ask on Discord
4. Email the maintainers
See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
---
**Last Updated**: 2025-01-XX
**Documentation Version**: 0.1.0
**SuiForge Version**: 0.1.0
---
Happy reading! 📚