This is the current Planet documentation entry point. Docs are organized by reader path: start with business architecture to understand data products, then move into user manuals or implementation references.

Business Architecture

Business Architecture and Data Flows: purpose, collection flow, fact tables, derived tables, cache, and WebSocket broadcast path for each Earth data product
Naming Glossary: English/Chinese terms used across the console, Earth, backend, and docs

Manual

Quickstart: shortest path to getting Planet running from scratch
Planet Manual: user workflows for the console, Earth, Docs, and common features
FAQ: troubleshooting for Windows / WSL, ports, dependencies, motion capture, credentials, and Docs permissions

Earth Implementation

Earth Frontend Context: Earth modules, state, WebSocket refresh, and layer lifecycle
Earth Layer Style Reference: layer colors, symbols, materials, and visual parameters
Earth Render Layer Order: renderOrder, depth strategy, picking, and collision avoidance
Earth Satellite Footprint Policy: satellite footprint display boundaries and strategy
BGP Context: BGP rendering, aggregation, and collector implementation in Earth
Earth Interactable Usage: Interactable API, lifecycle, and integration examples
Earth Toolbar and Overlay Coordination: close matrix for toolbar buttons, search, settings, news, and layer overlays

Frontend Implementation

Admin Frontend Context: console page structure, state boundaries, and lazy loading
Frontend Layout Guidelines: layout, tables, panels, and responsive constraints
Tactile UI Components: button, switch, tooltip, scrollbar APIs, and theme tokens

Backend Implementation

Data Collectors: collectors, task types, save layer, and status updates
System Service Control: backend service control and system operation APIs
Datasource Collector Settings and Connectivity: datasource catalog, collector settings, connectivity validation, and credentials
Datasource API Performance: DataSources list API performance and caching
Data Jobs and Outbox Architecture: PostgreSQL job queue, outbox, listener, and Kafka / Spark evolution boundaries
Shared Location Resolution Pipeline Development Guide: location resolver / pipeline interfaces, registries, and extension points
News Live Streams Collector Format: news, live stream, and media collection payload conventions
Docs Gatekeeper Development Guide: backend Docs catalog, Markdown content loading, and Gatekeeper permission groups

Agents and Operations

AI Provider Guide: model provider adapters, task prompts, and invocation boundaries
Planet Ops Runbook: deployment, startup, troubleshooting, and sensitive operations
Docker + Compose + Buildx Upgrade: Docker toolchain upgrade steps
planet.sh Startup: startup script, health checks, and performance optimization

Plans and History

Incomplete roadmaps, large refactor proposals, and future plans live in the repository path docs/plans/README.md. Completed, outdated, or replaced designs live in docs/deprecated/README.md.