Documentation Map
Overview
Section titled “Overview”This document provides a comprehensive map of all documentation available for the Warcraft II Notifications Plugin. Use this guide to quickly find the information you need.
Quick Navigation
Section titled “Quick Navigation”🚀 Getting Started
Section titled “🚀 Getting Started”- Home - Project overview and quick start
- User Guide - Installation and usage instructions
- Quick Start - Step-by-step setup guide
👨💻 For Developers
Section titled “👨💻 For Developers”- Development Guide - Development environment and workflow
- API Documentation - Complete API reference
- Architecture - System design and components
- Onboarding - New contributor guide
- Contributing - Contribution guidelines
🚢 For Operations
Section titled “🚢 For Operations”- Deployment Guide - Installation and operations
- CI/CD Pipeline - Pipeline technical reference
- GitHub Workflows - Workflow documentation
- npm Publishing - npm authentication and token management
- Documentation Deployment - How docs are deployed
⚙️ Configuration
Section titled “⚙️ Configuration”- Plugin Schema - Configuration schema reference
- Schema Validation - Validation guide
- User Guide - Configuration - Configuration examples
🔧 Troubleshooting
Section titled “🔧 Troubleshooting”- Troubleshooting Guide - Common issues and solutions
- User Guide - FAQ - Frequently asked questions
- Deployment - Troubleshooting - Deployment issues
Documentation by Audience
Section titled “Documentation by Audience”For End Users
Section titled “For End Users”Getting Started
Section titled “Getting Started”- Installation - How to install the plugin
- Configuration - Basic configuration options
- Using the Plugin - How to use features
- Sound Factions - Available sound options
Customization
Section titled “Customization”- Custom Sound Directory - Using custom sounds
- Faction Selection - Choosing Alliance/Horde
- Configuration Examples - Real-world examples
Support
Section titled “Support”- Troubleshooting - Problem resolution
- FAQ - Common questions
- Updating - How to update
For Developers
Section titled “For Developers”- Development Environment - IDE and tools setup
- Project Structure - Codebase organization
- Initial Setup - First-time setup
Development
Section titled “Development”- Development Workflow - Day-to-day workflow
- Testing - Testing strategies and tools
- Code Quality - Linting and formatting
- Debugging - Debugging techniques
Architecture
Section titled “Architecture”- System Architecture - High-level design
- Component Architecture - Module details
- Data Flow - How data moves through the system
- Module Dependencies - Dependency graph
API Reference
Section titled “API Reference”- Notification Module - Core plugin logic
- Sound Manager - Sound selection and playback
- Configuration - Configuration management
- Schema Validator - Configuration validation
- Bundled Sounds - Sound file management
Contributing
Section titled “Contributing”- Contributing Guide - How to contribute
- Code of Conduct - Community standards
- Pull Request Process - PR guidelines
For DevOps/Operations
Section titled “For DevOps/Operations”Deployment
Section titled “Deployment”- Deployment Overview - Deployment strategies
- Platform-Specific Setup - macOS/Linux setup
- Sound File Management - Managing sound files
- Configuration Management - Managing configs
- Pipeline Overview - Complete pipeline reference
- GitHub Workflows - Workflow documentation
- npm Publishing - npm authentication and publishing
- Smart Version Bump - Automated versioning
- Release & Publish - Release automation
- Auto-Merge Bot - PR automation
Operations
Section titled “Operations”- Monitoring - Monitoring and logging
- Troubleshooting - Operational issues
- Backup & Recovery - Data management
Documentation by Topic
Section titled “Documentation by Topic”Installation & Setup
Section titled “Installation & Setup”| Document | Section | Description |
|---|---|---|
| User Guide | Installation | End-user installation |
| Development Guide | Getting Started | Developer setup |
| Deployment Guide | Installation | Production deployment |
| Onboarding | Environment Setup | New contributor setup |
Configuration
Section titled “Configuration”| Document | Section | Description |
|---|---|---|
| User Guide | Configuration | User configuration guide |
| API Documentation | Plugin Configuration | Configuration API |
| Schema Documentation | Schema Reference | JSON schema details |
| Deployment Guide | Configuration Management | Production config |
Architecture & Design
Section titled “Architecture & Design”| Document | Section | Description |
|---|---|---|
| Architecture | System Architecture | High-level design |
| Architecture | Component Architecture | Module details |
| Architecture | Data Flow | Data flow diagrams |
| API Documentation | Type Definitions | TypeScript types |
Testing
Section titled “Testing”| Document | Section | Description |
|---|---|---|
| Development Guide | Testing | Testing strategies |
| Development Guide | Unit Tests | Unit testing guide |
| Development Guide | Integration Tests | Integration testing |
| Development Guide | Test Coverage | Coverage requirements |
CI/CD & Automation
Section titled “CI/CD & Automation”| Document | Section | Description |
|---|---|---|
| Pipeline Documentation | Overview | Pipeline architecture |
| GitHub Workflows | Workflows | Workflow details |
| GitHub Workflows | Setup Guide | Workflow setup |
| npm Publishing | Authentication | npm token management |
| npm Publishing | Token Renewal | Quick token renewal |
| Deployment Guide | CI/CD Integration | Deployment automation |
Troubleshooting
Section titled “Troubleshooting”| Document | Section | Description |
|---|---|---|
| Troubleshooting Guide | Common Issues | General problems |
| User Guide | Troubleshooting | User issues |
| Deployment Guide | Troubleshooting | Deployment issues |
| User Guide | FAQ | Frequently asked questions |
Quick Start Checklist
Section titled “Quick Start Checklist”For Users
Section titled “For Users”- Read Home for project overview
- Follow Installation Guide
- Configure Faction Preference
- Test the plugin with OpenCode
- Review Troubleshooting if needed
For Developers
Section titled “For Developers”- Read Development Guide
- Set up Development Environment
- Review Architecture
- Read API Documentation
- Review Contributing Guidelines
- Run tests:
bun test - Check code quality:
bun run lint && bun run type-check
For DevOps
Section titled “For DevOps”- Read Deployment Guide
- Review Pipeline Documentation
- Understand GitHub Workflows
- Set up Monitoring
- Configure CI/CD
Documentation Standards
Section titled “Documentation Standards”All documentation in this project follows these standards:
Structure
Section titled “Structure”- Clear hierarchical organization
- Table of contents for long documents
- Consistent heading levels
- Cross-references between related documents
Content
Section titled “Content”- Code examples with syntax highlighting
- Mermaid diagrams for visual representation
- Step-by-step instructions
- Real-world examples
- Troubleshooting sections
Maintenance
Section titled “Maintenance”- Regular updates with code changes
- Version information in headers
- Last updated dates
- Clear ownership and contact information
External Resources
Section titled “External Resources”Project Links
Section titled “Project Links”- GitHub Repository: pantheon-org/opencode-warcraft-notifications
- npm Package: @pantheon-ai/opencode-warcraft-notifications
- Live Documentation: GitHub Pages
- Issue Tracker: GitHub Issues
- Discussions: GitHub Discussions
OpenCode Resources
Section titled “OpenCode Resources”- OpenCode Documentation: opencode.ai/docs
- Plugin Development: opencode.ai/docs/plugins
- Configuration: opencode.ai/docs/config
Related Technologies
Section titled “Related Technologies”- TypeScript: typescriptlang.org
- Bun: bun.sh
- Zod: zod.dev
- Astro Starlight: starlight.astro.build
Contributing to Documentation
Section titled “Contributing to Documentation”Documentation improvements are always welcome! See:
- Contributing Guide - Documentation contribution guidelines
- Documentation Standards - Style and formatting standards
How to Contribute
Section titled “How to Contribute”- Find an Issue: Check documentation issues
- Make Changes: Edit documentation files in
docs/src/content/docs/ - Test Locally: Run
cd docs && bun run devto preview - Submit PR: Create a pull request with your changes
Support
Section titled “Support”Need help? Here’s where to go:
- User Questions: GitHub Discussions
- Bug Reports: GitHub Issues
- Security Issues: Security Policy
- General Inquiries: support@pantheon-ai.com
“Work complete!” - Warcraft II Peasant
”Zug zug!” - Warcraft II Orc
Last Updated: 2025-11-11
Maintained By: Pantheon AI Team