Pro-repo pass: README overhaul, cleanliness audit, submodules, CI#1
Merged
Conversation
…uilt, verified buildathon context - Modern structure: hero + badges + nav, status table, Mermaid architecture, live deployment + addresses, quickstart, repo tree, security model, roadmap. - Brand DA showcased via optimized images (docs/readme/, ~1.8MB total). - Honest framing: Aave exit is fork-verified but runs vs a mock on Robinhood → real Aave/GMX integration moved to roadmap; experimental/unaudited disclaimer. - Arbitrum Open House London context (adversarially verified facts), live URL, sponsor tech actually used (Robinhood Chain, Alchemy, OpenZeppelin).
…ns, not 'mock') Aave/GMX aren't live because they're not deployed on Robinhood Chain yet — the exit engine is built & verified against real Aave V3 and ships the day they land. Drop 'mock for the demo' framing; engaging, honest, reason-led roadmap.
Technical/niche framing (CLI guardian for a non-atomic-exploit failure mode, not a consumer app). Drop inline images (logo only) and heading emojis; keep status emojis in tables. ASCII architecture diagram, GitHub alert callouts, tables, TOC, 5 flat-square badges. Problem-first, dense, low-fluff.
…nglish-only Verified by a multi-agent audit (adversarially filtered). Changes: - contracts: drop unused 'deposits' mapping from MockVulnerableProtocol. - watcher: GUARDIAN_IMPL is now required from env (removed the hard-coded superseded 0x6671… fallback constant) → no stale impl address in source; drop unused 'amount' propagation from DrainedLog; tests updated (still 25). - watcher: translate the one residual French comment to English. - video: delete unused components (BevelCard, Caption) and 11 unreferenced PNGs (~12 MB); point LIVE_URL at coincoin-five.vercel.app. - site: dedupe the command card into <CommandCard>; drop dead SectionHeading 'align' branch; trim unused DEPLOY_PROOF keys + TermTone export; refresh stale demo addresses to the live deployment. - docs/.env.example: RULES_ENGINE parity, fix GUARDIAN_IMPL comment, check done submission boxes. (local .env tidied to English; gitignored.) forge 64/1skip · watcher 25 · site build+lint clean · video typecheck+render OK.
Drop docs/superpowers (AI design specs/plans), docs/SUBMISSION.md (internal pre-submission notes), and docs/brand (build-in-public brand kit + 6 large master PNGs ~12MB). The design tokens' source of truth is the code (tailwind.config.js, video/src/theme.ts). Reworded the handful of comments/README lines that pointed at the removed files so nothing dangles. Keeps docs/readme/logo.png.
…OZ v5.6.1) contracts/lib held 1033 committed third-party files. Convert to standard Foundry submodules: tree now tracks 2 gitlinks + .gitmodules + foundry.lock (pinned commits) instead of vendored sources. Remappings unchanged; forge build + 64/1-skip tests pass. README clone updated to --recursive (with the submodule-update fallback).
…build+lint) + SECURITY.md Standard pro-repo files: CI runs the test/build matrix on push to main and on PRs (submodule-aware checkout for Foundry deps; the real-Aave fork test self-skips without ARBITRUM_ONE_RPC). SECURITY.md documents private vulnerability disclosure.
…et with the runbook - Dedupe the sticky header across Dashboard/Docs/License/Contact into one <PageHeader breadcrumb maxWidthClass> with the per-page actions as children. - Update the /docs deploy snippet to the canonical runbook (unset CHAIN, --skip-simulation, DeployRules + RULES_ENGINE + DEMO_AAVE_POOL).
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
A pass to make the repo clean, professional, and convention-following — no functional changes to the product, all suites green.
README
Cleanliness audit (multi-agent, adversarially verified)
depositsmapping (mock),amountpropagation (watcher), 2 unused Remotion components, deadSectionHeading alignbranch, unusedDEPLOY_PROOFkeys /TermToneexport.GUARDIAN_IMPLis now required from env (removed the hard-coded superseded0x6671…fallback — no stale impl address in source); stale demo addresses refreshed to the live deployment.<CommandCard>+<PageHeader>; 11 unused video PNGs (~12 MB) removed.Repo footprint (~1,220 → ~190 tracked files)
docs/superpowers/,docs/SUBMISSION.md,docs/brand/. Reworded the references so nothing dangles (code is the design-token source of truth).foundry.lock). Clone is now--recursive.Pro-repo standards
.github/workflows/ci.yml): contractsforge test· watchervitest· sitebuild + lint, on push to main and PRs.Verification
forge test64 pass / 1 skip · watcher 25 · site build + lint · video typecheck — all green.