Skip to content

docs: README cleanup — markets, quick start, strategy tiers#64

Draft
JaeLeex wants to merge 1 commit into
jl/osrs-para-btcswp-mainnet-marketsfrom
jl/readme-cleanup
Draft

docs: README cleanup — markets, quick start, strategy tiers#64
JaeLeex wants to merge 1 commit into
jl/osrs-para-btcswp-mainnet-marketsfrom
jl/readme-cleanup

Conversation

@JaeLeex

@JaeLeex JaeLeex commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Restructure Quick Start around testnet-as-default and the --mainnet + HL_TESTNET=false requirement.
  • Add a dedicated Markets & Instruments section separating native HL perps, Paragon osrs/para BTCSWP swap perps, and YEX yield markets (no more conflating YEX with Paragon mainnet BTCSWP).
  • Add honest strategy tiers (quoting_engine vs standalone vs experimental) and fix stale counts (19 strategies, 1300+ tests, 20 MCP tools).
  • Align top Railway deploy button with the hosted MCP runtime docs (was still pointing at legacy APEX template).

Stacks on #63 (jl/osrs-para-btcswp-mainnet-markets).

What was wrong in the old README

  • Markets buried at the bottom under a single “YEX & BTCSWP (mainnet)” heading that mixed YEX testnet yield perps with Paragon mainnet swap perps.
  • No mention of BTCSWP-OSRS / osrs:BTCSWP testnet Paragon swap perp.
  • Quick start implied engine_mm as the default first run; didn’t explain env/flag consistency checks.
  • Stale badges (14 strategies, 483 tests, 16 MCP tools) and contradictory Railway button (APEX template vs MCP runtime section).
  • grid_mm incorrectly marked as requiring quoting_engine.

Test plan

Made with Cursor

Clarify testnet defaults, separate native perps / Paragon osrs-para BTCSWP /
YEX yield markets, fix stale counts and Railway button mismatch, and document
quoting_engine vs experimental strategies honestly.

Co-authored-by: Cursor <cursoragent@cursor.com>
@JaeLeex

JaeLeex commented Jul 1, 2026

Copy link
Copy Markdown
Contributor Author

Merge order (stacked chain): #63#64#65#66

Rebased #65 onto this branch (jl/readme-cleanup); #66 stacks docs/deploy cleanup on #65.

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