Documentation ownership¶
Use one authoritative home for each kind of information. Current source and configuration establish implementation; acceptance requires the evidence and authority stated in the roadmap. Neither a prose edit nor code presence closes an unresolved gate.
| Home | Owns | Consumers |
|---|---|---|
| Repository README | Concise project introduction, maturity limits and practical entry points | Prospective users and contributors |
| Technical guides | Current installation, operation, architecture and development procedures | Users, locally served site and installed operator links |
| Roadmap | Active requirements, decisions, dependencies and acceptance gates | Subsystem work; WebSDR and Server numbering remain separate |
| Verification | Selected measurements, regressions and limitations with necessary data | Public claims and unresolved reliability gates |
| ADRs | Consequential reasoning and explicit amendments | Architecture and compatibility work |
| Operator quick reference | Short status commands and links into current procedures | Installer's ~/README.md convenience copy |
| WebSDR navigation | Topic navigation, no second roadmap | Repository and installer's ~/WEBSDR.MD copy |
| Agent instructions | Implementation, privacy, deployment and contribution safeguards | Automated contributors |
| Schemas, decoder manifests, source provenance | Executable/data contracts and exact imports | Builds, tests, generated decoder reference and packaging |
Retention decisions¶
| Material | Disposition and reason |
|---|---|
| Monolithic WEBSDR plan | Consolidated into topic roadmaps; checklist meaning and open gates retained; superseded permission/run narratives removed |
| README milestones and Phase 0 completion diary | Removed; accepted requirements/ADRs retained, prototype measurements make no current performance claim |
| Map handoff and station-intelligence note | Consolidated into current map/station chapters; shared ownership and geography constraints retained |
| UAT implementation diary | Detailed criteria retained in the aviation roadmap companion; final aircraft acceptance and open weather gate replace the progress log |
| Native-client proposal | Retained as a scoped, unapproved evaluation with acceptance criteria |
| Scattered installation/architecture/client redirects | Removed in favor of current authoritative chapters |
| Long appliance runbook | Reduced to useful status commands and local guide links; example inventory and copied configuration removed |
| Server 4–7 reports | Consolidated into delivery/onboarding/ingestion/browser regression records; failures, measurements and limitations retained |
| Server product/WAL/admission evidence | Selected source-bound data retained beside the products report; routine runner and fixture handoffs removed |
| FCC, decoder optimization and GOES reports | Retained for concrete comparative/reference evidence; obsolete deployment/rollback diaries removed |
| Component browser ADRs | Moved alongside project ADRs; dated decisions/amendments preserved |
The verification index identifies each retained claim and limitation. Data moves do not grant new qualification. No executable consumer of the old evidence paths was found; installer document consumers and site-generation inputs are validated separately.
Maintenance¶
Keep examples neutral, explicitly synthetic and suitable for operator customization. Preserve public attribution, license notices and legitimate public reference data. Delete obsolete owner-specific prose after extracting any still-required principle; do not create a historical dump or a tombstone for every removed page.
Record a requirement, decision, result or limitation once. Do not append routine execution diaries, conversations or successive "currently implementing" updates. A retained result needs source/date association, factual outcomes and scope limits. Keep raw private diagnostics outside Git and publication roots.
Before moving a document, inspect scripts, tests, packaging and installer inputs. The docs build includes roadmap, verification and ADR sources without tracked copies. Run strict build, repository link/anchor and installed-link checks; a successful site build alone does not establish repository-wide link validity.