Tenki Cloud Documentation

Welcome to Tenki Cloud’s documentation. This is your starting point for understanding the system architecture, development practices, and operational procedures.

Note: This documentation is built with mdBook. Run pnpm docs:dev to view it locally.

Quick Links

• New to Tenki? Start with Getting Started
• Architecture Overview - System Architecture
• API Reference - Backend API Guide
• Deployment - Deployment Guide

Documentation Organization

📐 Architecture

System design, technical decisions, and architectural diagrams.

• Architecture Overview
• Architecture Decision Records
• System Diagrams

💻 Development

Everything you need to start developing on Tenki Cloud.

• Getting Started - Set up your dev environment
• Backend Development - Go services and APIs
• Frontend Development - React/Next.js apps
• Database Guide - Schema and migrations

🚀 Operations

Deployment, monitoring, and incident response.

• Deployment Guide
• Monitoring
• Runbooks - Operational procedures

📋 Product

Product vision, roadmap, and requirements.

• Product Roadmap
• Product Requirement Docs

Contributing to Documentation

When to Add Documentation

• Architecture changes → Add an ADR
• New features → Add a PRD
• Operational issues → Add a runbook
• API changes → Update the relevant guide

Documentation Standards

1. Keep it concise - Get to the point quickly
2. Use examples - Show, don’t just tell
3. Date your docs - Add “Last updated: YYYY-MM-DD” to guides
4. Test your instructions - Make sure they actually work

Quick Doc Updates

# Install mdBook (first time only)
./docs/install-mdbook.sh

# Edit documentation
vim docs/src/development/getting-started.md

# Preview locally with hot reload
pnpm docs:dev

# Build static site
pnpm docs:build

# Submit changes
git add docs/
git commit -m "docs: update getting started guide"

Finding Information

By Role

Backend Engineer

• Backend Development Guide
• Database Schema
• API Patterns

Frontend Engineer

• Frontend Development Guide
• Component Patterns
• State Management

DevOps/SRE

• Deployment Guide
• Monitoring Setup
• Incident Runbooks

Product Manager

• Product Roadmap
• Feature PRDs
• Success Metrics

By Task

“I need to…”

• Set up my development environment → Getting Started
• Understand the system design → Architecture Overview
• Deploy to production → Deployment Guide
• Debug an issue → Runbooks
• Plan a new feature → PRD Template

Maintenance

This documentation is maintained by the engineering team. Each team member is responsible for keeping their area of expertise documented.

• Backend team owns: Backend guide, database docs, API patterns
• Frontend team owns: Frontend guide, component docs
• DevOps team owns: Deployment, monitoring, runbooks
• Product team owns: Roadmap, PRDs, metrics

Last updated: 2025-06-12