Documentation index
Start with the guide for your role; the rest is reference.Running the app
| Document | Use it to |
|---|---|
| Deploy guide | Set up the server, deploy, back up and restore, troubleshoot |
| Configuration guide | Look up every setting in .env |
| Session Key setup | Create and check the Polymarket Session Key |
| Telegram | Connect a Telegram bot for notifications |
| Live verification | Test real trading at minimum sizes before going live |
| Incident runbook | Act on a leaked key, unexpected fills, stuck orders or a venue outage |
Using the app
| Document | Use it to |
|---|---|
| User guide | Learn the app, from the quick start to every feature |
| Glossary | Look up a trading term |
| Order rules | Look up order statuses, reject messages and the exact order rules |
Working on the code
| Document | Use it to |
|---|---|
| Developer setup | Run the app locally |
| Tooling | Understand the lint gates and dev tools |
| CLAUDE.md | Follow the coding, copy and git conventions |
| Plan | See decisions, roles, architecture and phases |
| Architecture overview | Understand actors, data flow and storage |
| Browser protocol | Read the REST and WebSocket protocol |
| Decision records | See why key choices were made |
| Polymarket notes | Check verified venue behaviour and captured fixtures |
| Design specs | Check screens, components, motion and copy |
| QA | Run and extend the end-to-end suite |
Security
| Document | Use it to |
|---|---|
| Threat model | See what the app defends against |
| Secrets and logging | Check how secrets are handled |
| Review checklist | Review a change that touches keys, auth, risk or the network |
| Findings | Per-phase reviews: security/findings-*.md |