Skip to content

docs: refresh README + point logo at marketing landing#163

Merged
ozpool merged 1 commit into
mainfrom
docs/readme-refresh-and-logo-home
May 28, 2026
Merged

docs: refresh README + point logo at marketing landing#163
ozpool merged 1 commit into
mainfrom
docs/readme-refresh-and-logo-home

Conversation

@ozpool
Copy link
Copy Markdown
Owner

@ozpool ozpool commented May 28, 2026

Summary

Two small things, one PR:

  1. Logo link — TopNav's perplex mark now points at `/` (the marketing landing with the "Signed, settled, sovereign" hero) instead of `/markets`. Brand mark should always feel like "go home"; on the trade page, the previous /markets target was already where the user came from, but the root marketing page is what really reads as the home surface.
  2. README refresh — replaces the three-terminal manual quickstart with `./scripts/dev-up-all.sh` as the primary path, documents the live Pyth Hermes oracle relayer, adds a troubleshooting block, and lists the new `funding.{marketId}` WS channel.

README diff highlights

  • Quickstart uses dev-up-all by default; manual flow kept as "advanced".
  • Demo wallet snippet (anvil Phase 0: Cargo workspace + perplex-core crate (types, margin, eip712, api) #5) + 100k USDC dev-seed note.
  • Live-oracle verification trick (`curl /v1/markets | jq` twice 2s apart).
  • Troubleshooting block: empty Position panel, JWT ExpiredSignature, "static" pill, etc.
  • WS channels table gains `funding.{marketId}` + the framed-op subscribe example.
  • Capabilities list adds live Pyth marks, cross-margin aggregates, slippage-aware liq, self-trade prevention, 8h funding.

Test plan

  • pnpm -C web typecheck clean
  • Open /trade, click perplex logo → lands on / with the Hero
  • Skim updated Quickstart against a fresh clone (out of scope here)

Logo
- TopNav <Link> now points at "/" instead of "/markets". The brand mark
  should always feel like a "go home" affordance; the marketing landing
  with the Hero ("Signed, settled, sovereign") lives at the root, so
  send users there.

README
- Replace the three-terminal manual quickstart with ./scripts/dev-up-all.sh
  as the primary path. Manual flow kept as an "advanced" appendix.
- Add the demo wallet (anvil #5) snippet + 100k USDC dev-seed note.
- Document the live Pyth Hermes oracle relayer: --with-oracle flag, the
  "oracle relayer spawned" boot log, the Pyth pill on the trade page,
  and the curl-twice trick to verify indexPriceX18 is ticking.
- Add a Troubleshooting block (empty Position panel = self-trade /
  wrong wallet, JWT ExpiredSignature = edge rotated secret, "static"
  pill = Hermes fetch failing).
- WebSocket channels table gains funding.{marketId} and the framed op
  protocol example.
- Capabilities list grows live-Pyth marks, cross-margin aggregates,
  slippage-aware liq, self-trade prevention, and the 8h funding cadence
  + UTC settlement boundary fact.
- Tech stack line on oracles now reflects Hermes streaming in every
  environment.
@ozpool ozpool merged commit 40cf55f into main May 28, 2026
3 of 4 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