Technical Docs
This directory holds "current implementation and current structure" documentation, focusing on:
- How the code is organized right now
- Where the current entry points are
- How state and components work
- Which implementation boundaries future changes should follow
What belongs here:
- Quickstart and user manual
- Frontend context
- Earth frontend structure
- Earth satellite footprint policy
- Earth render layer order
- Earth layer style property index
- Backend runtime control
- Collector status
- Collector settings and connectivity validation
- Earth Interactable integration
- Collection format conventions
Entry Points
- Quickstart: The shortest path to getting Planet running from scratch
- Planet Manual: Complete usage guide for the console,
planet.sh, Earth, and Docs - FAQ: Central troubleshooting entry for Windows / WSL, ports, dependencies, motion capture, credentials, and Docs permissions
- Earth Location Candidate Collection User Guide: Collect and preview coordinate candidates for compute centers and BGP collectors on Earth
- Collector Settings and Connectivity Validation: Data source catalog, collector settings, connectivity validation, and BarentsWatch credentials
- Shared Location Resolution Pipeline Development Guide: Backend location resolver / pipeline interfaces, registries, and extension points
- Docs Gatekeeper Development Guide: Backend Docs catalog, Markdown content loading, and Gatekeeper permission groups
- Earth Interactable Usage: API, lifecycle, and integration examples for Earth surface icon Interactable
- Earth Toolbar and Overlay Coordination: Closing matrix and integration rules for toolbar buttons, search, settings, news, and layer overlays
What does not belong here:
- Incomplete roadmaps
- Future iteration plans
- Large-scale refactor proposals
Those belong in: