Skip to content

rewrite root readme around tables, numbers, and live proof#23

Closed
AnkanMisra wants to merge 1 commit intomainfrom
docs/readme-rewrite
Closed

rewrite root readme around tables, numbers, and live proof#23
AnkanMisra wants to merge 1 commit intomainfrom
docs/readme-rewrite

Conversation

@AnkanMisra
Copy link
Copy Markdown
Owner

@AnkanMisra AnkanMisra commented May 3, 2026

Summary

Rewrites the root README to read like a polished, judge-facing artifact rather than a running build log. Same factual content reorganised around dense tables, concrete numbers, and the live on-chain proof.

What changed

  • At-a-glance table at the top: status, hot-path latency, verdict ladder, test count, sponsors, total addressable prizes, runtime, frontend, container story
  • Live on-chain proof moved into a single 7-row table with explorer links (rootHash, storage tx, block, gas, network)
  • Why ChainShield rewritten as an attack-pattern table mapping each treasury risk to the rule that catches it
  • Three verdicts, five rules explicit table of the decision ladder with verdict, risk score, and notes per rule
  • Architecture Mermaid diagram now includes the AXL gossip leg + a trait-seam table covering all five replaceable dependencies (Store, Simulator, PlaybookRunner, NotificationChannel, GossipTransport)
  • Sponsor integrations restructured as four sections (0G, KeeperHub, Gensyn AXL, Discord), each with a "where / what" table linking adapter, call site, error path, and live proof
  • Quick start + Script reference table covering every npm script that actually exists in package.json
  • Test coverage table with all 13 test files and their domain
  • Repo layout table (top-level dirs and their purpose)
  • Quality bar table mapping every CI gate to the tool that enforces it
  • Roadmap now / next / later table separating shipped work from designed-but-unshipped extensions
  • Pointers table indexing every doc under docs/

Test plan

  • bun test (109 / 109 pass)
  • bun run typecheck:server (zero errors)
  • Emoji scan locally (no banned bytes in README.md)
  • Every script referenced in the README exists in package.json
  • Every file path linked from the README exists on main

Notes

No source code touched. Pure documentation rewrite.


View in Codesmith
Need help on this PR? Tag @codesmith with what you need.

  • Let Codesmith autofix CI failures and bot reviews

@cloudflare-workers-and-pages
Copy link
Copy Markdown

Deploying chainshield with  Cloudflare Pages  Cloudflare Pages

Latest commit: 67536bc
Status: ✅  Deploy successful!
Preview URL: https://5d75ef67.chainshield.pages.dev
Branch Preview URL: https://docs-readme-rewrite.chainshield.pages.dev

View logs

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 3, 2026

Warning

Rate limit exceeded

@AnkanMisra has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 1 minute and 27 seconds before requesting another review.

To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: ffa4d78d-02d5-4fa5-867e-f16221dc2648

📥 Commits

Reviewing files that changed from the base of the PR and between 2cb681c and 67536bc.

📒 Files selected for processing (1)
  • README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-rewrite

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
Review rate limit: 0/1 reviews remaining, refill in 1 minute and 27 seconds.

Comment @coderabbitai help to get the list of available commands and usage tips.

@AnkanMisra
Copy link
Copy Markdown
Owner Author

obsolete - root README on main has been intentionally kept in its previous shape; all README work consolidated in #24

@AnkanMisra AnkanMisra closed this May 3, 2026
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