Gosei Play Documentation

Welcome to the Gosei Play documentation! This directory contains comprehensive documentation for the Gosei Play Go game platform.

📚 Documentation Structure

docs/
├── getting-started/          # Quick start and installation guides
├── features/                 # Feature documentation
│   ├── time-controls/       # Time control systems
│   ├── game-types/          # Game modes and board sizes
│   ├── ai-integration/      # KataGo AI integration
│   └── scoring/             # Scoring rules and Ko implementation
├── deployment/              # Deployment guides for various platforms
├── development/             # Development documentation
├── troubleshooting/         # Common issues and solutions
├── archive/                 # Historical documentation
│   └── bug-fixes/          # Bug fix documentation
└── change_logs/            # Change logs and migration notes
    └── restructure/        # Repository restructuring docs

---

🚀 Quick Links

For New Users

• Quick Start Guide - Get started in minutes
• Main README - Project overview and features

For Developers

• Project Status - Current development status
• Planning - Development roadmap
• Version History - Detailed version changelog
• Security - Security guidelines

For Deployment

• VPS Deployment - Deploy to VPS
• Production VPS - Production setup
• Heroku Setup - Deploy to Heroku
• Netlify Deploy - Deploy to Netlify

---

📸 Screenshots

Main Page

Multiple Go Board Support

Play View

Mobile Play View

---

📖 Documentation by Topic

⏱️ Time Controls

Learn about Gosei Play's professional-grade time control system:

• Time Control Flexibility
• Byo-yomi Implementation
• Time Tracking System
• Time per Move Behavior

🎮 Game Types & Features

• Board Sizes - 9×9 to 21×21
• Game Type Behaviors
• Blitz Game Rules
• Play Again Feature
• Game Review
• Spectator Mode

🤖 AI Integration

• AI Integration Guide
• KataGo Setup Guide
• KataGo Windows Setup
• AI Network Selection

🎯 Scoring & Rules

• Ko Rule Implementation
• Ko Rule Quick Reference
• Ko Rule Details

🚀 Deployment

• VPS Deployment Guide
• Ubuntu VPS Setup
• Nginx SSL Setup
• Redis Deployment
• PM2 Configuration

🛠️ Development

• Project Planning
• Project Status
• Version History
• Changelog
• Move Storage System

🐛 Troubleshooting

• Troubleshooting Guide
• Immediate Fix Instructions

---

📂 Archive

Historical documentation and bug fixes are archived for reference:

• Bug Fixes Archive - Historical bug fix documentation
  • Timer fixes, AI fixes, UI fixes, and more

---

📝 Change Logs

Repository restructuring and migration documentation:

• Change Logs - All change logs and migration notes
• Restructure Docs - Repository cleanup documentation

---

🎯 Documentation Standards

File Naming

• Use SCREAMING_SNAKE_CASE.md for documentation files
• Be descriptive and specific
• Group related docs in subdirectories

Content Structure

Each documentation file should include:

1. Title - Clear, descriptive title
2. Overview - Brief summary of the topic
3. Details - Comprehensive information
4. Examples - Code examples where applicable
5. References - Links to related documentation

Updating Documentation

When updating docs:

1. Keep information current and accurate
2. Update related documentation
3. Add to changelog if significant
4. Follow existing formatting conventions

---

🔍 Finding Documentation

By Feature

Look in features/ subdirectories for feature-specific documentation.

By Task

• Getting Started → getting-started/
• Deploying → deployment/
• Developing → development/
• Troubleshooting → troubleshooting/

By Topic

Use the table of contents above or browse the directory structure.

---

🤝 Contributing

To contribute to documentation:

1. Follow the documentation standards above
2. Place files in appropriate directories
3. Update this README if adding new categories
4. Submit a pull request with clear description

---

📞 Need Help?

• Issues? → Check Troubleshooting
• Questions? → Review Quick Start
• Deployment? → See Deployment Guides

---

📊 Documentation Statistics

• Total Files: 77 documentation files
• Categories: 9 main categories
• Last Reorganized: 2025-12-04
• Maintained by: Gosei Play Team

---

Happy Reading! 📖

For the latest updates, check VERSION.md and CHANGELOG.md.