Skip to content

Redesign the README: banner, Example walkthrough, flow card and status - #40

Merged
operatoruplift merged 3 commits into
mainfrom
claude/readme-redesign
Oct 31, 2026
Merged

operatoruplift merged 3 commits into
mainfrom
claude/readme-redesign

Conversation

@operatoruplift

@operatoruplift operatoruplift commented Oct 30, 2026 •

Copy link
Copy Markdown
Owner

What changed

The README was a long verification document with no visuals. This rebuilds it in the same house style as the Allowance README, so Lotline, RWA Lens, Buffer and Allowance read as one family, in Lotline's own forest green.

  • Header: banner, three buttons (Try the example, Open the planner, Watch the demo), CI, site and stack badges, the homepage's own line ("Choose your xStocks. Set your split. Review your next step."), the Choose → Split → Estimate → Verify → Share → Review on Jupiter loop, and section links.
  • Screens card: four real screens of Example mode (the 10.000001 USDC precision split, Verify this plan, the shared-plan review dialog, and the Jupiter handoff), rendered for light and dark themes.
  • How it works: a You → Lotline → Your wallet flow card, three guarantees, and Example versus Live. The planner steps and the full precision and freshness rules move into collapsible sections, word for word where they were operational.
  • Ecosystem integrations: PreStocks, Pyth, Backpack and Meteora in one table, with every check from the old sections kept in a collapsible block.
  • Markets, Portfolio and community plans: the four operator flags in one table, with three phone screens reused from the repository's own dApp Store listing kit (no new image files).
  • Status: LIVE, OPT-IN, GATED, VALIDATING and HACKATHON rows with the same scoping as before: no purchase, settlement, store release or event submission is claimed.
  • Run it locally: prerequisites, the no-credential command, everything CI runs (including the flag-on markets suite and the PWA suite), and an environment table that now covers every variable in .env.example. Deploy, storage and limits, install and Seeker, dependency review and repository layout move into collapsible sections.
  • Documentation: every doc the old README linked, grouped in one table. A script check confirms all 45 links from the old README are still present (one was corrected, below).

Fixes:

  • The RVAClassic link pointed at x.com/operatoruplift; it now points at x.com/rvaclassic.
  • The run steps said npm ci without an npm version. With npm 10 (Node 22's bundled npm, 10.9.4 here) npm ci stops with Missing: [email protected] from lock file; CI installs npm 11 first for exactly this reason. The README now says so.
  • Deploy step 1 named 6 of the 14 migrations in supabase/migrations/. It now says to apply all of them in timestamp order (supabase db push) and keeps the guest-execution caution.
  • package.json gains description, homepage and repository (separate commit; the lockfile is unaffected).

Removed or folded in, with the reason:

  • "737 of the 832 xStocks hold a DBC token badge": no dated record of this count exists in the repository, so the number was dropped and the mechanism kept. Restore it with a dated source if you have one.
  • The "September 19 local continuation" section said itself that it is superseded; the finish report stays linked under Documentation, marked historical.
  • The "In 20 seconds" paragraph and the dated 20 and 21 September update paragraphs are folded into the summary, Status and the integrations table with their original scoping.

All images live in docs/readme/ (five PNGs, about 1 MB). Screenshots come from a local production build (npm run build and next start, no credentials) in Example mode, so every figure on them is synthetic. The three phone screens come from docs/dapp-store/screenshots, captured from lotline.dev by scripts/generate-store-kit.mjs.

Checks

  • npx -y npm@11 ci: installed 793 packages. Plain npm ci with npm 10.9.4 fails as described above.
  • npm run lint: passed with zero warnings.
  • npm run typecheck: passed.
  • npm test: 74 files passed, 3 skipped; 783 tests passed, 4 skipped.
  • npm run build: passed (Next.js 16.4.3), with no Supabase or RPC credentials.
  • Not run here: the two Playwright browser suites (test:e2e and test:e2e:markets), which need a CI-style build with fixture Supabase settings. CI runs both on every push and pull request, and this PR changes no application code.
  • README check: no broken relative links or anchors, alt text on every image, no em or en dashes. Previewed in GitHub's light and dark layouts.
  • When this branch was pushed, GitHub reported 8 Dependabot alerts on main (4 high, 4 moderate). Dependency changes are out of scope here; the high-severity Meteora SDK chain is analysed in docs/dependency-review-20260926.md.

Suggested repository settings

These live outside the code, so they are not in this PR:

  • Description: the current one is accurate and dash-free; no change needed.
  • Homepage: https://lotline.dev already matches the app's metadataBase, sitemap and Supabase site_url.
  • Topics: keep nextjs, pwa, solana, supabase, xstocks; consider adding token-2022, tokenized-stocks, jupiter, pyth and solana-mobile.
  • Social preview: upload docs/readme/banner.png (2400 × 1200) under Settings → General → Social preview.

https://claude.ai/code/session_01TZhsuWjATuivuiFYJGpbY5


Generated by Claude Code

- Add a banner, Example-mode walkthrough and flow cards (light and
  dark) rendered from a local production build in docs/readme/
- Restructure into How it works, Ecosystem integrations, Markets and
  flags, Status, Run it locally and Documentation; long reference
  material moves into collapsible sections
- Fix the RVAClassic link (it pointed at x.com/operatoruplift) and
  document npm 11, which CI pins: npm 10 cannot run npm ci on this
  lockfile
- Cover every .env.example variable and all migrations in the deploy
  steps; drop the undated 737-of-832 DBC badge count

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Claude-Session: https://claude.ai/code/session_01TZhsuWjATuivuiFYJGpbY5
- Description from the project's own one-liner, homepage lotline.dev
  (the metadataBase, sitemap and Supabase site_url), and the GitHub
  repository; the lockfile is unaffected

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Claude-Session: https://claude.ai/code/session_01TZhsuWjATuivuiFYJGpbY5
- Restore the redesign delivery, technical walkthrough, pitch source
  and historical screenshots links from the old Product materials list

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Claude-Session: https://claude.ai/code/session_01TZhsuWjATuivuiFYJGpbY5
@vercel

vercel Bot commented Oct 30, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
lotline Ready Ready Preview Oct 30, 2026 8:22pm UTC

Request Review

@operatoruplift
operatoruplift merged commit 33b1591 into main Oct 31, 2026
3 checks passed

This branch was successfully deployed

1 active deployment
Preview — 5e67efd5 Deployed Oct 30, 2026 by vercel[bot]
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.

2 participants