docs: reposition README as verification layer (refs #34, #31)#46
Conversation
- Replace title/subtitle with verifier-first positioning - Move comparison table directly below opening (strongest identity proof) - Reframe problem statement around AI-agent-era gate - Move Procedural Accuracy section up (key differentiator) - Remove 'Production Ready' status claims → 'Verification Layer' - Add explicit Non-Goals section (GSTN, GSTR, e-Invoicing, HSN/SAC, filing, etc.) - Fix broken heading 'What QWED Tax Verification System' → 'Verification Coverage' - Replace 'Enterprise-Grade Tax Code Verification Engine' → 'Deterministic Tax Verification Layer for AI Agents' - Accounts Payable: 'Automation → Verification' language - Roadmap: 'ERP Integrations → ERP Verification Connectors', remove platform language - Reorder sections: identity → comparison → problem → architecture → procedural accuracy → coverage → non-goals → guards → privacy → install → SDK → examples → roadmap
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
|
Warning Review limit reached
More reviews will be available in 54 minutes and 23 seconds. Learn how PR review limits work. Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file). ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits. 🚦 How do rate limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan refill rate. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, the refill rate gradually slows as usage increases. The highest same-day bursts are limited more strictly. Please see our Fair Usage Limits Policy for further information. 📝 WalkthroughWalkthrough
ChangesREADME Rewrite
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (2)
README.md (2)
29-29: 🧹 Nitpick | 🔵 Trivial | ⚡ Quick winFix heading level to match document structure.
Line 29 uses h3 (
###) but should be h2 (##) since it is a top-level section. The previous line is a divider (---), and heading levels should increment consistently after the main title (h1).📝 Proposed fix
-### ⚔️ Why QWED-Tax? +## ⚔️ Why QWED-Tax?🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` at line 29, The heading "⚔️ Why QWED-Tax?" is currently using h3 level (###) but should use h2 level (##) to maintain proper document structure consistency. Since this is a top-level section following the main title, change the three hash symbols (###) prefix to two hash symbols (##) for this heading to ensure consistent heading hierarchy throughout the document.Source: Linters/SAST tools
45-51: 🧹 Nitpick | 🔵 Trivial | ⚡ Quick winSpecify a language for the fenced code block.
The ASCII diagram block does not declare a language. Add
textorasciias the code block language for clarity and proper rendering.📝 Proposed fix
-``` +```text AI-generated tax decision ↓ Deterministic verification (Allow / Block / Unverifiable) ↓ Execution system (Gusto, Avalara, Stripe) -``` +```🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` around lines 45 - 51, The fenced code block containing the ASCII diagram (showing the flow from AI-generated tax decision through deterministic verification to execution system) is missing a language specifier. Add `text` as the language identifier to the opening code fence (the line with ```) to properly declare the code block language for improved rendering and clarity.Source: Linters/SAST tools
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@README.md`:
- Line 29: The heading "⚔️ Why QWED-Tax?" is currently using h3 level (###) but
should use h2 level (##) to maintain proper document structure consistency.
Since this is a top-level section following the main title, change the three
hash symbols (###) prefix to two hash symbols (##) for this heading to ensure
consistent heading hierarchy throughout the document.
- Around line 45-51: The fenced code block containing the ASCII diagram (showing
the flow from AI-generated tax decision through deterministic verification to
execution system) is missing a language specifier. Add `text` as the language
identifier to the opening code fence (the line with ```) to properly declare the
code block language for improved rendering and clarity.
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
- Move closing code fence before Accounts Payable heading (Sentry) - Fix heading level ### → ## for Why QWED-Tax? (CodeRabbit, Greptile P2) - Add text language specifier to ASCII diagram code block (CodeRabbit) - Replace 'Compliance Block' → 'Verification Block' in TS example (Greptile P2)
|
1 participant
Summary
Repositions the README to communicate QWED-Tax's identity as a deterministic verification layer — not a tax platform, GST compliance suite, or payroll system.
Implements the positioning direction from #34 (Path B) and addresses the overclaim flagged in #31.
What changed
Identity (top of README)
Deterministic Verification for Payroll, Tax, and Compliance→The Verification Gate for AI-Generated Tax DecisionsScope boundaries
✅ Production Ready→🟢 Verification Layer(both US and India)Language fixes
What QWED Tax Verification System(broken heading) →Verification CoverageEnterprise-Grade Tax Code Verification Engine→Deterministic Tax Verification Layer for AI AgentsAccounts Payable (AP) Automation→Accounts Payable Verificationsecures the entire Procure-to-Pay cycle→verifies tax decisions in the Procure-to-Pay cycleCompliance: Blocks Input Tax Credit→Verification: Blocks Input Tax CreditAuto-calculates TDS/Retention amounts→Verifies TDS/Retention amountsRun compliance checks→Run verification checksIndia (Income Tax / GST / FEMA)→India (CBDT / CBIC / FEMA)Roadmap
ERP Integrations (SAP/Oracle)→ERP Verification Connectors — verify tax decisions before they enter SAP/OracleMassive vision for Global Tax Verification→Expanding verification guard coverage to more jurisdictions and tax rulesVerification GuardsorVerification ConnectorsSection reorder
What did NOT change
Success criteria
A first-time reader should understand within 30 seconds:
Refs #34, #31
Summary by CodeRabbit