Welcome to the Gosei Play documentation! This directory contains comprehensive documentation for the Gosei Play Go game platform.
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 Start Guide - Get started in minutes
- Main README - Project overview and features
- Project Status - Current development status
- Planning - Development roadmap
- Version History - Detailed version changelog
- Security - Security guidelines
- VPS Deployment - Deploy to VPS
- Production VPS - Production setup
- Heroku Setup - Deploy to Heroku
- Netlify Deploy - Deploy to Netlify
Learn about Gosei Play's professional-grade time control system:
- Board Sizes - 9×9 to 21×21
- Game Type Behaviors
- Blitz Game Rules
- Play Again Feature
- Game Review
- Spectator Mode
Historical documentation and bug fixes are archived for reference:
- Bug Fixes Archive - Historical bug fix documentation
- Timer fixes, AI fixes, UI fixes, and more
Repository restructuring and migration documentation:
- Change Logs - All change logs and migration notes
- Restructure Docs - Repository cleanup documentation
- Use
SCREAMING_SNAKE_CASE.mdfor documentation files - Be descriptive and specific
- Group related docs in subdirectories
Each documentation file should include:
- Title - Clear, descriptive title
- Overview - Brief summary of the topic
- Details - Comprehensive information
- Examples - Code examples where applicable
- References - Links to related documentation
When updating docs:
- Keep information current and accurate
- Update related documentation
- Add to changelog if significant
- Follow existing formatting conventions
Look in features/ subdirectories for feature-specific documentation.
- Getting Started →
getting-started/ - Deploying →
deployment/ - Developing →
development/ - Troubleshooting →
troubleshooting/
Use the table of contents above or browse the directory structure.
To contribute to documentation:
- Follow the documentation standards above
- Place files in appropriate directories
- Update this README if adding new categories
- Submit a pull request with clear description
- Issues? → Check Troubleshooting
- Questions? → Review Quick Start
- Deployment? → See Deployment Guides
- 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.