docs: rewrite Readme.md from the actual codebase - #271
Merged
Chucks1093 merged 1 commit intoAug 31, 2026
Merged
Conversation
The existing Readme.md only described the invoice-financing half of the app and referenced tooling that doesn't exist in this repo (test:e2e, test:a11y, test:coverage scripts, Docker, Vercel CLI steps, an MIT license with no LICENSE file backing it). Rewrote it from the real source: full app/ route tree, every lib/api export (invoices, KYC, admin invoice review/settlements, and the previously-undocumented Creator Keys system — buy/burn/transfer, governance voting, vesting, whitelisting, dividends, admin trading pause/timelock, audit log), the real package.json scripts, actual .env.example values, and the real test setup (Vitest + Testing Library, no e2e/a11y suite present). Left README.md (a separate tracked file — this repo has both README.md and Readme.md as distinct git paths, which collide on case-insensitive filesystems) untouched; only Readme.md changes here.
|
@codemagician1949 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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
2 participants
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.
Problem
Readme.mddescribed only the invoice-financing half of the app and referenced tooling that isn't actually in this repo —test:e2e,test:a11y,test:coveragescripts, Docker, Vercel CLI steps, and an MIT license claim with noLICENSEfile backing it.What changed
Rewrote it from the real source instead of polishing the template copy:
app/route tree (auth, KYC, seller/investor dashboards, admin, creator keys, marketplace, profile)lib/api/index.ts, including the Creator Keys system (buy/burn/transfer, governance voting, vesting, whitelisting, dividend distribution, admin trading pause/timelock, audit log) — none of which the old Readme mentioned at allpackage.jsonscripts only (no fabricated ones).env.examplevaluesCONTRIBUTING.md(dev-only PRs, branch naming, Conventional Commits)LICENSEfile exists, rather than repeating an unbacked MIT claimCloses #132
Closes #131
Closes #130
Closes #128
Note for reviewers
This repo has both
README.mdandReadme.mdtracked as separate git paths, which collide on case-insensitive filesystems (macOS/Windows) — only one can physically exist in a checkout at a time, and Git will show both as "modified" locally even when only one was touched. Verified withgit diff --cachedbefore committing that onlyReadme.mdactually changed;README.md's blob is untouched. Worth deciding which of the two should be the canonical file going forward, but out of scope for this PR to unilaterally delete one.