Day 1: Replacing The Docusaurus Scaffold With Project Documentation
· 2 min read
The first pass over the Docusaurus site was about removing generic scaffold content and making the docs reflect the actual FastAPI-mapserver deployment and runtime model.
The project already had enough moving parts to justify real operational documentation:
- a FastAPI application with a large router surface
- MapServer and MapCache sitting behind the service layer
- Celery and Redis for asynchronous processing
- terrain generation and Mago output handling
- HySpex ingestion paths that can fan out into batch jobs
What changed on day 1 was not just the text. The docs site started to describe the real deployment shape:
- the public host layout under
/docs,/ui,/guide, and the OGC endpoints - storage and manifest behavior under
/data - deployment files and local swarm profiles
- caching, terrain, and HySpex workflows from an operator point of view
That matters because this repository is not a library. It is an operating service, and the documentation has to answer practical questions like:
- where job state is persisted
- how MapCache is regenerated and cleaned
- which manifests define dataset and terrain state
- how public URLs map to runtime services
By the end of the first day, the docs site had stopped looking like a default Docusaurus starter and started reading like the control-plane manual for the stack we actually run.