Skip to content

README.md

Latest commit

 

History

History
153 lines (120 loc) · 5.02 KB

README.md

File metadata and controls

153 lines (120 loc) · 5.02 KB

PokManagerApi Documentation

Welcome to the comprehensive documentation for PokManagerApi, a modern control plane for managing ARK: Survival Ascended servers via POK Manager.

Documentation Index

Getting Started

  • Getting Started Guide - Complete setup and installation instructions
    • Environment setup
    • Prerequisites installation
    • First-time configuration
    • Running the application
    • Troubleshooting common issues

Architecture

  • Architecture Overview - Detailed architecture documentation
    • Clean Architecture principles
    • Layer descriptions and responsibilities
    • Dependency rules and flow
    • Design patterns and practices
    • Testing strategy
    • Architecture diagrams

Development

  • Development Guide - Developer workflow and guidelines
    • Development workflow
    • TDD with TinyBDD
    • Coding standards and conventions
    • Testing guidelines
    • Build system (Nuke)
    • IDE setup and configuration
    • Debugging tips and tricks

API Reference

  • API Documentation - REST API reference (Coming Soon)
    • Endpoint documentation
    • Request/response schemas
    • Authentication
    • Error handling

Components

  • Component Documentation - Blazor components (Coming Soon)
    • UI component library
    • Component usage examples
    • Styling guidelines

Deployment

  • Deployment Guide - Production deployment (Coming Soon)
    • Docker deployment
    • Aspire deployment
    • Cloud deployment options
    • Security considerations
    • Monitoring and logging

Quick Links

External Resources

Internal Documentation

Documentation Standards

All documentation follows these principles:

  1. Clear and Concise - Easy to understand with concrete examples
  2. Up-to-Date - Documentation is updated with code changes
  3. Comprehensive - Covers both happy paths and edge cases
  4. Practical - Includes real-world usage examples
  5. Accessible - Written for developers of all experience levels

Contributing to Documentation

When contributing to the project, please also update relevant documentation:

  • Update README.md for new features
  • Add examples to getting-started.md for setup changes
  • Document architectural changes in architecture.md
  • Update development.md for new workflows or tools

Documentation Structure

docs/
├── README.md                    # This file - documentation index
├── getting-started.md           # Setup and installation guide
├── architecture.md              # Architecture documentation
├── development.md               # Development workflow guide
├── api-reference.md             # REST API reference (planned)
├── components.md                # Blazor component docs (planned)
├── deployment.md                # Deployment guide (planned)
├── command-builders-examples.md # Command builder examples
├── architecture/                # Detailed architecture docs
│   └── README.md               # Architecture structure
└── images/                      # Screenshots and diagrams
    ├── dashboard.png
    ├── instance-management.png
    └── backup-management.png

Finding What You Need

For New Users

Start with the Getting Started Guide to set up your development environment and run the application.

For Developers

Review the Development Guide to understand the TDD workflow and coding standards.

For Architects

Study the Architecture Overview to understand the system design and layer responsibilities.

For DevOps

Check the Deployment Guide for production deployment strategies.

Support

If you can't find what you're looking for in the documentation:

  1. Check the GitHub Issues
  2. Start a Discussion
  3. Review the Agent Instructions for detailed project guidelines

Documentation Roadmap

Completed

  • ✅ Architecture documentation
  • ✅ Getting started guide
  • ✅ Development guide

In Progress

  • 🔄 API reference documentation
  • 🔄 Component documentation
  • 🔄 Deployment guide

Planned

  • 📋 Security best practices
  • 📋 Performance tuning guide
  • 📋 Backup and recovery procedures
  • 📋 Monitoring and observability
  • 📋 Migration guides
  • 📋 FAQ and troubleshooting

Last Updated: 2026-01-19 Version: 1.0.0 Maintainers: PokManagerApi Team