EDOS documentation¶
Audience: Agent + operator
Documentation for the EDOS workspace: multiple independent Elite Dangerous-related projects collected in one directory (not a monorepo). These files are written for humans and coding agents who need to navigate, extend, or integrate with the ecosystem.
Start here¶
| If you need... | Read |
|---|---|
| A bootstrap page for new repos / new agents | START_HERE.md |
| A compact machine-friendly entrypoint | AGENT_INDEX.md |
| Deployment checklist in one page (agent-first) | AGENT_DEPLOYMENT_QUICKREF.md |
| Agent bootstrap snippets (system prompt, global User Rule, compose/README starters) | Not on the docs site — clone the edos repo and open docs/templates/ locally; workflow: START_HERE.md |
| What belongs in this doc set and what does not | SCOPE.md |
| How docs are written (links, TODO rules, terminology) | DOC_CONVENTIONS.md |
| Folder-by-folder inventory and run commands | REPOS.md |
Production hostnames, ed* slugs, and naming new apps |
HOSTNAMES.md |
| How systems connect (journal flow, services, diagrams, fair use of community APIs via cache) | ARCHITECTURE.md |
postMessage protocol and parent/popup setup |
IPC.md |
| URL bootstrap, embedding options, integration manifests (distinct from IFM journal IPC) | HOSTED_APP_CONTRACT.md |
| Federated app discovery registries (optional; link-only indexes for composition hosts) | APP_DISCOVERY_REGISTRY.md |
| Optional visual identity (colors, typography, layout — orange on black; third-party link attributions) | DESIGN_GUIDANCE.md |
| Data-dense table behavior (views, filters, highlights — Stellar Scan as reference) | TABLE_GUIDANCE.md |
| Checklists for agents (IPC, journal, new apps) | AGENTS.md |
| Real-world journal / sidecar samples (workspace-local; ask if missing) | AGENTS.md — journalFilesSamples/ at workspace root when present |
| Deployment instructions (self-hosted/public patterns) | DEPLOYMENT.md |
| Operator handoff for running agents in other repos | HANDOFF_FOR_EXTERNAL_AGENTS.md |
Early WebView / postMessage considerations (historical context) |
original-concept.md |
Per-project capsules¶
Short, scannable pages under apps/:
- api-cache-server
- docs-deploy
- elite-dangerous-event-types
- elite-dangerous-journal-event-viewer
- elite-dangerous-local-journal-reader
- elite-dangerous-remote-journal-reader
- elite-dangerous-surface-map
- elite-dangerous-stellar-scan
- elite-dangerous-credit-account
- elite-dangerous-planet-analyser
- stellar-forge-helper
- elite-dangerous-interstellar-scan (may be git-only in workspace)
- elite-dangerous-expedition-planner
- elite-dangerous-universe-map
- elite-dangerous-universe-places (may be git-only in workspace)
- elite-dangerous-systems-uninhabitet (may be scaffold-only in workspace)
- elite-dangerous-orrery-map
- elite-dangerous-living-interior
- elite-dangerous-planet-scan
- elite-dangerous-app-composition
- inter-frame-messenger
Open gaps¶
Consolidated in TODO.md. Doc history for this tree: CHANGELOG.md.
Suggested reading order (agents)¶
- SCOPE.md
- REPOS.md
- ARCHITECTURE.md + IPC.md
- HOSTED_APP_CONTRACT.md when changing query parameters, integration manifests, or iframe / embed entrypoints for hosted web UIs
- APP_DISCOVERY_REGISTRY.md when building or operating composition hosts, registry indexes, or catalog UX
- DESIGN_GUIDANCE.md when adding or restyling user-visible UI in first-party apps
- TABLE_GUIDANCE.md when the main surface is a sortable, filterable data table
- Relevant apps/ capsule(s)
- AGENTS.md before editing
- Optional: HANDOFF_FOR_EXTERNAL_AGENTS.md when a human operator delegates to another repository