Documentation
This is the index. Start with whichever section matches what you're looking for.
This is the index. Start with whichever section matches what you're looking for.
Product
- Product Requirements (PRD) — vision, users, problem, MVP scope, success metrics
- Roadmap — phased plan from MVP to marketplace
- Glossary — trading vocabulary and project-specific terms
Architecture
- Overview — the big picture, components, data flow, stack
- Agent Runtime — how
runSkillworks - Execution Engine — the safety boundary between AI and exchange
- Simulation — backtest replay loop
- Live Runtime — Fly-based per-skill processes
- Chat Agent — single product-wide chat agent: authoring, coaching, prepare-action confirm-cards
- Chat Agent Prompts — exact persona, tier addenda, mode addenda, trust rules, dialogue flows, suggested prompts
- Tools & MCP — tool registry pattern and MCP integration
- Data Model — Supabase schema
Decisions (ADRs)
Architecture Decision Records — one per non-trivial choice we've made, with context and consequences.
- 0000 — ADR template
- 0001 — MVP exchange: Hyperliquid
- 0002 — Agent runtime: Vercel AI SDK + AI Gateway
- 0003 — Database: Supabase
- 0004 — Live runner host: Fly.io
- 0005 — Skill authoring: form, not code
- 0006 — Split trading agent and chat agent
- 0007 — Imperative commands stay out of chat
- 0008 — No live dashboard in MVP
- 0009 — Structured strategy fields replace free-text system prompt
- 0010 — OpenRouter replaces Vercel AI Gateway for model routing
- 0011 — News integration via CryptoPanic
- 0012 — Strategy authoring: thesis mode, leash dial, AI co-author
- 0013 — Paper broker: isolated-margin leverage + liquidation accounting (superseded by 0014)
- 0014 — Paper broker: cross-margin; live brokers source state from exchange
- 0015 — Deprecate Hyperliquid testnet; mainnet-only live target
- 0016 — Hyperliquid agent wallet model
- 0017 — Trading agent memory layer
- 0018 — Market event calendar
- 0019 — One chat agent for authoring, coaching, and ops
- 0020 — Chat agent memory: trading-memory exposure + user-facts layer
Security
- Trust Boundaries — who can do what, where the lines are
- Risk Controls — kill switch, position caps, daily loss halt
- Secrets — exchange keys, API tokens, what lives where
Operations
- Environments — dev / preview / production matrix
- Launch checklist — five-phase path from code-in-repo to first real-money tick, with verification queries and incident response
Development
- Setup — local dev environment
- Contributing — workflow, ADR process, code style
Documentation conventions
- One topic per file. If a doc grows past ~400 lines, split it.
- Lead with the decision or summary. Reader should know the gist in 30 seconds.
- Diagrams in ASCII in the doc itself. Avoid binary diagrams that drift from the code.
- Cross-link liberally. Use relative links between docs.
- Date the doc if it captures a point-in-time decision. ADRs include a date in the header.
- Update or delete. Stale docs are worse than missing docs.