Documentation scope (EDOS workspace)

Audience: Agent + operator

This document defines what the EDOS documentation set is responsible for covering, and what it deliberately excludes. It is aimed at readers and coding agents that need to modify existing projects or add new ones without treating the workspace as a monorepo.

What this workspace is

The edos directory aggregates multiple standalone projects in one place so the ecosystem can be described and navigated coherently. Each top-level folder is its own unit of build, test, and release unless a later doc states a deliberate coupling.

Projects present at this scope definition (names only; per-project detail comes in later phases):

Folder	Role (high level)
api-cache-server	HTTP API service (Bun/Elysia/Prisma under api/); UI may exist alongside per project layout.
elite-dangerous-event-types	TypeScript types for journal file events (published package name in that project’s package.json).
elite-dangerous-local-journal-reader	Tauri desktop shell: watches journal + sidecar files and republishes BridgeEnvelope to an embedded web UI (edos:file:event / IFM edos-file-event) — see apps/elite-dangerous-local-journal-reader.md.
elite-dangerous-journal-event-viewer	Hosted journal event viewer (EDJEV); desktop install via local journal reader build-service only — apps/elite-dangerous-journal-event-viewer.md. Top-level folder in this workspace may hold only .git until the app repo is cloned or the submodule is populated.
elite-dangerous-remote-journal-reader	Hosted journal reader UI (Quasar); local files via File System Access API — see ARCHITECTURE.md.
elite-dangerous-surface-map	Surface map UI and related logic (Quasar/Vue app under ui/).
elite-dangerous-stellar-scan	Hosted Stellar Scan body table (Vite + Solid); journal + SPANSH via api-cache — apps/elite-dangerous-stellar-scan.md.
elite-dangerous-credit-account	Hosted Credit Account ledger from journal events (Vite + Solid) — apps/elite-dangerous-credit-account.md.
elite-dangerous-planet-analyser	Headless HTTP scan-credit / analysis API (Bun/Elysia) — apps/elite-dangerous-planet-analyser.md.
stellar-forge-helper	Shared npm library for id64 / boxel addressing (@howfe/stellar-forge-helper).
elite-dangerous-interstellar-scan	Separate hosted app repo; folder may be .git only until cloned — apps/elite-dangerous-interstellar-scan.md.
elite-dangerous-expedition-planner	Hosted web app for an ordered system expedition plan: manual route entry, progress tracking, and next-jump display — apps/elite-dangerous-expedition-planner.md.
elite-dangerous-universe-map	Separate hosted app repo; may be .git only — apps/elite-dangerous-universe-map.md.
elite-dangerous-orrery-map	Separate hosted app repo; may be .git only — apps/elite-dangerous-orrery-map.md.
elite-dangerous-living-interior	Separate hosted app repo; may be .git only — apps/elite-dangerous-living-interior.md.
elite-dangerous-planet-scan	Separate hosted app repo; may be .git only — apps/elite-dangerous-planet-scan.md.
elite-dangerous-app-composition	Separate hosted app repo; may be .git only — apps/elite-dangerous-app-composition.md.
elite-dangerous-universe-places	Separate hosted app repo; may be .git only — apps/elite-dangerous-universe-places.md.
elite-dangerous-systems-uninhabitet	Separate hosted app repo (uninhabitable systems table); may be scaffold-only until cloned — apps/elite-dangerous-systems-uninhabitet.md.
inter-frame-messenger	Cross-context messaging (e.g. host ↔ embedded web UI).
docs	Documentation for the ecosystem (this tree).
docs-deploy	MkDocs Material + nginx Docker pipeline that publishes docs/ to static HTML (human /) and agent /raw/ Markdown — see apps/docs-deploy.md.
journalFilesSamples	Real-world Journal*.log lines and sidecar JSON for local verification (not an app). Workspace-local only — not published on the docs site; may be absent in some clones. Agents: see AGENTS.md.

Some folders may be incomplete in a given clone (sparse checkout, submodule, or work in progress) — expected; see DOC_CONVENTIONS.md — Partial workspace checkouts and REPOS.md. Open TODO.md for real documentation gaps, not missing files in a thin checkout alone.

In scope

• Architecture of how these projects fit together: data flow from journal files through readers to UIs and auxiliary services; use of shared types; caching and external APIs where relevant.
• Inter-process / embedding integration: how native or shell hosts talk to web UIs (postMessage, origins, WebView assumptions), building on themes in original-concept.md and grounding them in actual code.
• Operational expectations: how to build and run each project, environment assumptions, and compatibility notes for community tools (e.g. modern WebView vs legacy).
• Fair use of community HTTP APIs: routing third-party requests through the API cache server so volunteer-run services are not overloaded (see ARCHITECTURE.md).
• Extension guidance: where to plug in features, how to add a new project that participates in the same patterns without merging repos into a monorepo.
• Optional visual identity: recommended colors, typography, and layout patterns for first-party apps (DESIGN_GUIDANCE.md) — not a shared component library.
• Data-dense table patterns: saved views, filters, highlights, and field-registry architecture for grid-first tools (TABLE_GUIDANCE.md) — reference elite-dangerous-stellar-scan; not a shared component package.
• Agent-oriented playbooks: checklists, invariants, and “do not break” rules for IPC and journal handling.
• Curated data from other Elite Dangerous tools: EDOS does not import curated game data from other Elite Dangerous applications; use citable public references or verify and maintain the data in-repo — see DOC_CONVENTIONS.md.

Out of scope

• Turning this workspace into a monorepo (single root package, unified CI for all projects, or forced shared versioning). Docs may recommend patterns; they will not assume a monorepo layout.
• Frontier / game internals beyond what community tools observe via journal and public APIs.
• Official Elite Dangerous support or endorsement; this is third-party/community documentation.
• Duplicating upstream reference docs (full journal schema encyclopedia) where a link plus project-specific usage notes suffices—unless a maintainer explicitly wants a local mirror.
• Publishing journalFilesSamples/ on the static docs site or embedding large journal excerpts in hosted Markdown — use AGENTS.md (ask the operator for samples when needed).
• User-facing tutorials for playing the game, unless they are needed to explain a specific tool’s behavior.

Boundaries

• Documentation may live in a separate repository later; scope is the same: describe the ecosystem and contracts, not “only what lives in one git root.”
• Per-project deep dives belong in docs/apps/PROJECT_SLUG.md (see DOC_CONVENTIONS.md), not in this file.

Revision

When new top-level projects are added to the workspace, update the table in this file and, if needed, DOC_CONVENTIONS.md naming examples.

Documentation index

Full table of contents: README.md.