Skip to content

Warvest docs banner

Home

This is the home of all engineering documentation. It lives in the repo, is versioned with the code, and stays close to the reality it describes.

What lives here?

🚀 Onboarding

Setup steps and the first reading list. Start here

📏 Standards

Naming, coding, and Git rules we follow by default. Start here

🧭 ADR (Architecture Decision Record)

Frozen decisions and the reason we made them. Start here

🏗️ Architecture

Living docs for how the system works today. Start here

🎮 Playbook

Repeatable procedures and operational how-tos. Start here

When do I write what?

  • An architecture-level decision like tooling, branching, data model, or save format → ADR.
  • How a system works today or how it should be verified and reviewed → Architecture.
  • A team rule or convention for code, assets, or Git flow → Standards.
  • A recurring operational task or support procedure → Playbook.
  • A small, low-risk feature that does not change shared behavior → usually no doc, just a solid PR description.