Agentic Trader Docs

Developer Docs

Start here for setup, architecture, runtime truth, and the rules that keep Agentic Trader inspectable.

What this docs site is for

Agentic Trader already has a real local runtime, real persistence, and real operator surfaces. The job of this docs site is to make that system easier to navigate without inventing a second architecture.

These docs are written for contributors who need to answer questions like:

  • Which package owns this behavior?
  • Which UI is reading shared runtime truth versus inventing local state?
  • Where should setup, feedback, QA, and review expectations live?
  • Which repo notes must be updated when a behavior changes?

Reading paths by job

If you are onboarding

  1. Read Getting Started.
  2. Validate the environment with doctor.
  3. Open the main operator surfaces before editing runtime behavior.
  4. Read Project State to understand what is already true.

If you are changing runtime behavior

  1. Read Architecture.
  2. Read Agent Pipeline.
  3. Read Runtime And Operations.
  4. Finish with QA And Debugging.

If you are touching docs or frontend surfaces

  1. Read Operator Surfaces.
  2. Read Frontend System.
  3. Read Memory And Review.
  4. Update .ai/current-state.md, .ai/tasks.md, and .ai/decisions.md together with the affected docs page.

Core non-negotiables

  • Local-first remains the default operating posture.
  • Paper trading remains the safe default execution mode.
  • Silent fallbacks are not acceptable when they hide degraded truth.
  • CLI, Rich, Ink, observer API, and Web GUI should describe the same runtime state.
  • The docs app and the Web GUI are shells around the existing runtime, not replacements for it.

Repo files worth keeping open

  • README.md
  • ROADMAP.md
  • .ai/profile.md
  • .ai/rules.md
  • .ai/architecture.md
  • .ai/current-state.md
  • .ai/memory.md
  • .ai/tasks.md
  • .ai/decisions.md
  • .ai/debugging.md
  • .ai/qa/qa-agent.md
  • .ai/qa/qa-checklist.md
  • .ai/qa/qa-runbook.md
  • .ai/qa/qa-scenarios.md

Current focus of this docs surface

Right now the docs are doing four jobs at once:

  • documenting the current runtime honestly
  • hardening onboarding expectations before a broader V1 push
  • keeping docs/ and webgui/ aligned on their shared frontend baseline
  • preserving project memory so contributors do not have to rediscover the same boundaries repeatedly

Docs maintenance contract

If a change moves runtime behavior, product direction, or developer workflow assumptions, update all of the following in the same branch:

  • the affected docs page
  • .ai/current-state.md
  • .ai/tasks.md
  • .ai/decisions.md

That keeps the docs site, repo memory, and implementation from drifting apart.

How was this page?
This GitHub Pages build prepares a browser-local feedback draft and a prefilled GitHub issue. Node-hosted local docs can still wire feedback into runtime logs later.

Stores a draft in this browser and gives you a GitHub issue link to submit when ready.

Getting Started

Install the repo, validate local readiness, and bring up the main operator surfaces.

On this page

What this docs site is forReading paths by jobIf you are onboardingIf you are changing runtime behaviorIf you are touching docs or frontend surfacesCore non-negotiablesRepo files worth keeping openCurrent focus of this docs surfaceDocs maintenance contract