إنتقل إلى المحتوى الرئيسي

Developer documentation

What this section is​

The developer documentation describes how AuroraSOC is built. It is written for engineers extending the platform, integrating with it, debugging it, or reading it for the first time after onboarding.

The build prompt's quality bar reads: a new backend engineer can read the developer docs and contribute a meaningful change to the orchestrator within two weeks.

How to read it​

Pages follow the same four-question structure as the user docs (what, why, how, what-goes-wrong). The audience layering is built in: a conceptual paragraph at the top, then the precise mechanics, then the code-level pointers. The same page serves the new contributor and the expert who already knows the system.

Each component page also includes:

  • A configuration reference (every knob, sensible defaults).
  • An observability summary (the metrics it emits, what its logs look like, how to know it is healthy).
  • Troubleshooting notes for common failure modes.

What is here today​

AuroraSOC is in the E2E demo lock and acceptance phase (ADR 021). The developer documentation contains:

  • This landing page.
  • The architecture overview, which summarises the seven planes.
  • The environment variables reference, covering every runtime configuration knob.
  • Component pages organised by architectural plane: agent fleet, EDR Linux sensor, CPS device plane, MCP plane, and observability.

Component pages land alongside the code they describe. The order is tracked in STATUS.md.

Contributing​

The contribution workflow, commit message format, and code-quality gates are documented in CONTRIBUTING.md. A contributor's setup walkthrough will land in this section once the first language workspace is populated.