Skip to content

docs: reorganize and update project documentation#4008

Merged
majestyotbr merged 4 commits into
mainfrom
docs
Jun 11, 2026
Merged

docs: reorganize and update project documentation#4008
majestyotbr merged 4 commits into
mainfrom
docs

Conversation

@majestyotbr

@majestyotbr majestyotbr commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • Documentation
    • Added a centralized docs hub with an index and three comprehensive guides: Architecture (system design, request lifecycle, data persistence, observability), Development (local setup, build, Lua/C++ workflow, testing, contribution & PR guidelines), and Operations (deployment options, monitoring/alerting, backups & restores, incident response, upgrades, runbooks).

@coderabbitai

coderabbitai Bot commented Jun 11, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 966add86-dde6-430f-b44f-1ce7eb069760

📥 Commits

Reviewing files that changed from the base of the PR and between 6d3c3ef and 29ff500.

📒 Files selected for processing (1)
  • docs/architecture.md
✅ Files skipped from review due to trivial changes (1)
  • docs/architecture.md

📝 Walkthrough

Walkthrough

Adds a documentation hub plus three comprehensive guides: architecture, development, and operations, documenting system design, contributor workflows, build/run instructions, and operational procedures.

Changes

Canary Comprehensive Documentation Suite

Layer / File(s) Summary
Documentation Hub and Project Overview
docs/README.md
Main entry point indexing architecture, development, and operations guides; includes repository overview, lifecycle, technology stack, deployment options, contributing guidance, and audience reading paths.
Architecture and System Design
docs/architecture.md
Documents layered C++20 core with Lua scripting, core subsystems (Game singleton, networking, creature hierarchy, combat, maps, events, persistence, scheduler), data pack layout, metrics, testing placement, Docker quickstart, and build toolchain.
Development Guide and Contributor Practices
docs/development.md
Contributor-facing guide covering development philosophy, environment setup (Docker and native), CMake/vcpkg dependency management, server runtime, Lua and C++ development practices, testing, debugging, PR workflow, and troubleshooting.
Operations and Deployment Guide
docs/operations.md
Operational runbook covering deployment models (Docker/native), infrastructure sizing, configuration/secrets management, database operations and backups, monitoring and alerting, release/upgrade procedures, incident response playbooks, security operations, and pre-production checklist.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Suggested reviewers

  • lgrossi
  • dudantas

🐰 Four guides in harmony,
Architecture, dev, and ops so grand,
Canary soars with clarity,
From concepts to command,
Happy hops for docs well planned.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main changes: adding/reorganizing comprehensive documentation (README.md, architecture.md, development.md, operations.md). It reflects the primary objective without being vague.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

gemini-code-assist[bot]

This comment was marked as spam.

coderabbitai[bot]

This comment was marked as spam.

coderabbitai[bot]

This comment was marked as spam.

@sonarqubecloud

Copy link
Copy Markdown

coderabbitai[bot]

This comment was marked as spam.

@majestyotbr majestyotbr merged commit f19dd8b into main Jun 11, 2026
4 checks passed
@majestyotbr majestyotbr deleted the docs branch June 11, 2026 23:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants