EDOS documentation

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 system prompt for hosted docs (URLs + rules; operators: see START_HERE.md)	templates/CURSOR_AGENT_BOOTSTRAP.md
Agent system prompt (production URLs hardcoded)	templates/CURSOR_AGENT_BOOTSTRAP_PROD.md
Global User Rule snippet (conditional bootstrap; Cursor Settings paste)	templates/CURSOR_USER_RULE_GLOBAL_BOOTSTRAP.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
How systems connect (journal flow, services, diagrams, fair use of community APIs via cache)	ARCHITECTURE.md
postMessage protocol and parent/popup setup	IPC.md
Checklists for agents (IPC, journal, new apps)	AGENTS.md
Deployment instructions (self-hosted/public patterns)	DEPLOYMENT.md
Bootstrap prompt and handoff for 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
• elite-dangerous-event-types
• elite-dangerous-local-journal-reader
• elite-dangerous-remote-journal-reader
• elite-dangerous-surface-map
• inter-frame-messenger

Open gaps

Consolidated in TODO.md. Doc history for this tree: CHANGELOG.md.

Suggested reading order (agents)

1. SCOPE.md
2. REPOS.md
3. ARCHITECTURE.md + IPC.md
4. Relevant apps/ capsule(s)
5. AGENTS.md before editing
6. HANDOFF_FOR_EXTERNAL_AGENTS.md when delegating to another repository