Skip to content

README: landing page with screenshots, guides in docs/guide - #4

Merged
markb-1 merged 4 commits into
mainfrom
claude/keen-allen-b8lq9q
Nov 1, 2026
Merged

markb-1 merged 4 commits into
mainfrom
claude/keen-allen-b8lq9q

Conversation

@markb-1

@markb-1 markb-1 commented Nov 1, 2026

Copy link
Copy Markdown
Owner

Summary

  • README is now a short landing page (83 lines, was 729): what BotLab is, a glimpse in screenshots (bots list, risk-refused orders, script editor, live Polymarket search, a real Claude Code agent chat and its answer, dashboard), a minimal quick start, how it stays safe, and a table of guides.
  • Reference material moved to docs/guide/, unchanged apart from cross-links: install.md, operations.md, scripting.md, strategies.md, agent.md, development.md. The remaining screenshots sit next to the text they illustrate.
  • 16 screenshots in docs/screenshots/ (~4.5 MB) from a paper-only demo instance with the default config and live market data. The agent chat images are rendered from the recorded transcript of a real Claude Code session against that instance's /mcp (the server refused its forecasts on the $5k volume floor; it rated CPI markets ambiguous and handed a mandate decision back).
  • Merged main (PRs BotLab v3 Phase 5: strategy templates (executor, position manager, consistency, resolution-rule, copy trading v2) #2 and Add check-polymarket connectivity check; never follow redirects with credential headers #3): their README edits are carried into the guides ("Hosting on a VPS" → install, min_liquidity_usd note → operations, executor / position manager / copy-trading changes → strategies, check-polymarket → development).
  • Messages that pointed at README sections (agent warning, Agent page, server.yaml comments and default, service script, code comments) now point at the guides.

Checks

  • All 48 relative links and #anchors in the README and guides resolve; every screenshot is referenced.
  • npm run typecheck clean; config tests passed before the merge. Full test suite not re-run locally after merging main: left to CI.

Review notes

  • The agent chat screenshots show the agent's own research on live markets dated 2026-11-01; check you're happy publishing them.
  • docs/SPEC.md still says the README holds the quick starts (left as the historical design doc).

🤖 Generated with Claude Code

markb-1 and others added 4 commits November 1, 2026 15:24
Eleven screenshots from a fresh paper-only install (default config, live
market data): bots list, a running bot's logs and orders (including risk
engine hold_time rejections), script editor, templates, live Polymarket
search, forecast ledger, risk limits editor, agent page, dashboard and a
phone view. Stored in docs/screenshots.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
A "Talk to the agent" part of the tour, from a real Claude Code session
against the paper-only demo instance (rendered from its recorded
transcript): the request and every tool call, including the forecasts the
server refused on the volume floor, and the agent's answer with a decision
for the owner. Plus the resulting run (summary and tool calls) and note on
the Agent page, the audit log, and how the scheduled agent is steered.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
README.md is now a short landing page: what BotLab is, a glimpse in
screenshots (risk-refused orders, script editor, live markets, the
Claude Code agent chat and its answer, dashboard), a minimal quick
start, the safety model and a table of guides.

The reference material moved, unchanged apart from cross-links, to
docs/guide/: install, operations, scripting, strategies, agent and
development, with the remaining screenshots next to the text they
illustrate. Messages that pointed at README sections (agent warning,
Agent page, server.yaml comments, service script) now point at the
guides.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Brings in PRs #2 and #3. Their README edits now live in the guides:
"Hosting on a VPS" in docs/guide/install.md, the min_liquidity_usd note in
operations.md, the executor / position manager / copy-trading changes in
strategies.md, and check-polymarket in development.md.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@markb-1
markb-1 merged commit 8e5a4cc into main Nov 1, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant