> ## Documentation Index
> Fetch the complete documentation index at: https://onyxresearch.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Platform Overview

> Review projects, campaigns, experiments, files, and diffs in the Onyx app.

The Onyx app is the shared review surface for research work reported directly to the API by the CLI and agents.

## Main Views

<CardGroup cols={2}>
  <Card title="Campaign graph" icon="workflow" href="/docs/platform/review">
    See experiments, tasks, workers, provenance, and best metrics.
  </Card>

  <Card title="Campaign review" icon="chart-line" href="/docs/platform/review">
    Inspect experiment order, statuses, values, and best-so-far steps.
  </Card>

  <Card title="File tree" icon="files" href="/docs/platform/review">
    Review changed files plus `onyx/` context for a selected experiment.
  </Card>

  <Card title="Diff view" icon="git-compare" href="/docs/platform/review">
    Compare an experiment against its previous best or another selected result.
  </Card>
</CardGroup>

## Common Workflow

<Steps>
  <Step title="Link a project">
    Attach an existing repository through GitHub or by URL.
  </Step>

  <Step title="Create or select a campaign">
    Define the research direction and metric.
  </Step>

  <Step title="Let agents run">
    Agents report experiments through `onyx-worker exp log`; the worker pushes the durable result ref before the API report can count.
  </Step>

  <Step title="Review progress">
    Use graph, overview, metrics, files, and diffs to decide what to continue.
  </Step>
</Steps>

## Realtime Updates

The app receives private team research events and merges them into its query cache. If repository metadata or code-read state looks stale, trigger project repository sync in the app. Research state itself is written through `/api/v1`, not through a local replay queue.