Skip to content

docs: index-vault docs, /docs page, README rewrite (S&P-500-on-chain positioning) - #80

Open
YD811 wants to merge 2 commits into
feat/index-vault-corefrom
docs/readme-and-docs-site
Open

docs: index-vault docs, /docs page, README rewrite (S&P-500-on-chain positioning)#80
YD811 wants to merge 2 commits into
feat/index-vault-corefrom
docs/readme-and-docs-site

Conversation

@YD811

@YD811 YD811 commented Jul 7, 2026

Copy link
Copy Markdown
Owner

What

Documentation layer for the index vault (stacked on #79 — retarget to main after it merges):

  • docs/architecture/index-vault.md — architecture, NAV math ("How the index token is priced"), buffer+queue redemptions, yield routing, "Looping: when leverage is free" (profitable ⟺ basket yield ≥ borrow rate, net APY ≈ y + L·(y − b)), security model, instruction reference.
  • docs/operations/index-keeper.md — keeper runbook: config, tick anatomy, incident playbook (NavDeviationTooHigh, stuck queue), key rotation, kill switch.
  • docs/operations/index-mainnet-runbook.md — launch gates, bootstrap commands, week-one guards, open decisions for YD.
  • /docs page in apps/web (design system, navbar link) + docs.potbot.fun host rewrite in next.config.mjs (assets excluded from the match so CSS/JS load).
  • README rewritten around the new positioning: "Infrastructure for on-chain vaults — think S&P 500, but on the blockchain"; index flow diagram, looping economy, quickstart with the localnet test recipe, condensed community/AI/MCP sections. CLAUDE.md one-liner synced.

🤖 Generated with Claude Code

YD811 and others added 2 commits July 7, 2026 20:13
- docs/architecture/index-vault.md — architecture, NAV math ('How the index token is
  priced'), redemption buffer+queue, yield routing, 'Looping: when leverage is free'
  (yield ≥ borrow cost condition), security model, instruction reference.
- docs/operations/index-keeper.md — keeper runbook (config, tick anatomy, incident
  playbook, key rotation, kill switch).
- docs/operations/index-mainnet-runbook.md — launch gates, bootstrap commands, open
  decisions for YD. docs/README.md index updated.
- apps/web /docs page in the PotBot design system + navbar link + docs.potbot.fun
  host rewrite in next.config.mjs (assets untouched).
- README.md rewritten: 'S&P 500 on the blockchain' positioning, index flow diagram,
  looping economy, quickstart with localnet test recipe, condensed community/AI/MCP
  sections, status table. CLAUDE.md one-liner synced.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@vercel

vercel Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
potbot-v2 Ready Ready Preview, Comment, Open in v0 Jul 7, 2026 6:18pm

Request Review

@supabase

supabase Bot commented Jul 7, 2026

Copy link
Copy Markdown

This pull request has been ignored for the connected project iybzibvnzgxqwhgmkopf because there are no changes detected in supabase directory. You can change this behaviour in Project Integrations Settings ↗︎.


Preview Branches by Supabase.
Learn more about Supabase Branching ↗︎.

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