# Pokedex.Online Documentation

**Central documentation hub for the Pokedex.Online project.**

## 📁 Directory Structure

```
Pokedex.Online/
├── README.md (you are here)
├── REFACTORING-PLAN.md ⭐ Start here for implementation roadmap
├── setup/                 Setup and deployment guides
│   ├── gamemaster-setup.md
│   ├── deployment.md (coming soon)
│   ├── monitoring.md (coming soon)
│   ├── gitea-cicd.md (coming soon)
│   ├── security.md (coming soon)
│   └── accessibility.md (coming soon)
├── api-reference/         API documentation and integration guides
│   ├── oauth-setup.md
│   ├── gamemaster-api.md
│   └── authentication.md (coming soon)
├── architecture/          System design and architectural decisions
│   ├── authentication.md (coming soon)
│   ├── internationalization.md (coming soon)
│   ├── feature-flags.md (coming soon)
│   └── deployment-architecture.md (coming soon)
├── roadmap/              Future features and enhancement plans
│   └── gamemaster-explorer-future.md
└── archive/              Historical documentation
    ├── implementation-notes.md
    └── cleanup.md
```

## 🚀 Quick Links

### For Development
- **[REFACTORING-PLAN.md](REFACTORING-PLAN.md)** - Complete refactoring roadmap with phases, timeline, and success metrics
- **[Gamemaster Setup](setup/gamemaster-setup.md)** - Set up gamemaster data processing
- **[OAuth Setup](api-reference/oauth-setup.md)** - Configure Challonge OAuth integration

### For API Integration
- **[Gamemaster API Reference](api-reference/gamemaster-api.md)** - Complete API documentation with examples
- **[Future Features Roadmap](roadmap/gamemaster-explorer-future.md)** - Upcoming features and enhancements

### For Historical Context
- **[Implementation Notes](archive/implementation-notes.md)** - Original implementation documentation
- **[Cleanup History](archive/cleanup.md)** - Previous cleanup and refactoring efforts

## 📝 Documentation Guidelines

When creating new documentation:

1. **Choose the correct folder**:
   - `setup/` - Installation, configuration, deployment guides
   - `api-reference/` - API endpoints, integration examples, authentication
   - `architecture/` - System design, architectural decisions, diagrams
   - `roadmap/` - Feature plans, enhancement proposals
   - `archive/` - Historical documents that are no longer actively maintained

2. **File naming convention**:
   - Use kebab-case: `feature-flags.md`, `deployment-architecture.md`
   - Be descriptive: Avoid generic names like `notes.md` or `info.md`

3. **Include in every document**:
   - Clear title and purpose
   - Date created/updated
   - Prerequisites (if applicable)
   - Examples and code snippets where relevant
   - Links to related documentation

4. **Keep it updated**:
   - Update docs alongside code changes
   - Archive outdated docs instead of deleting
   - Link to code files when referencing implementation

## 🔄 Refactoring Status

**Current Phase**: Phase 1 - Documentation & Project Setup  
**Progress**: Documentation organized ✅  
**Next**: Vitest setup and dependency splitting

See [REFACTORING-PLAN.md](REFACTORING-PLAN.md) for full status and timeline.

## 🤝 Contributing Documentation

When adding new features or making significant changes:

1. Check if existing documentation needs updates
2. Create new documentation in the appropriate folder
3. Update this README if adding new sections
4. Link from relevant places (main README, related docs)
5. Follow the documentation guidelines above

## 📧 Questions?

Documentation questions or suggestions? Update this file or create an issue in the project tracker.