docs: rewrite README and refresh contributor documentation - #315
Merged
Conversation
README - Concise, open-source oriented rewrite: what the project is, highlights, simplified architecture diagram, quick start, script table, contract inventory with frontend-wiring status, and a documentation index. - New screenshots of the redesigned UI (landing, borrower dashboard, lender portfolio) under docs/screenshots/. - Rate-limiting and payment-due scheduler sections moved into docs/rate-limiting.md and docs/payment-due-scheduler.md. Docs - CONTRIBUTING.md rewritten: main-branch workflow, Conventional Commits with the enforced scope list, the exact checks CI runs, PR expectations. - docs/roadmap.md now reflects what is shipped, in progress and planned. - docs/getting-started.md: removed the non-existent Docker setup, listed all 16 contract crates, completed the CI workflow table, fixed links. - CHANGELOG.md updated with the cleanup, Neon migration, CI fix and UI redesign work. - Fixed 34 root-relative links inside docs/ that did not resolve on GitHub; replaced references to removed sql/ scripts with the Drizzle schema/migrations; removed the last mention of Google sign-in. Cleanup - Deleted public/assets/hero-trust.png, unused since the hero redesign. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Advanced Run ID: 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 |
thisisouvik
changed the title
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
1 participant
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.
Summary
Phase 4 of the cleanup plan: professional, open-source friendly documentation. No application code changes.
README
docs/screenshots/): landing (dark), borrower dashboard (light), lender portfolio (dark).docs/rate-limiting.mdanddocs/payment-due-scheduler.md.Docs
main-based workflow (it referencedmaster), Conventional Commits with the scope list commitlint actually enforces, the exact checks CI runs, PR expectations.docker-compose.ymlexists), listed all 16 contract crates instead of 8, completed the CI workflow table, fixed links.docs/that 404'd on GitHub; replaced references to the removedsql/scripts with the Drizzle schema/migrations; removed the last "Continue with Google" mention.Cleanup
public/assets/hero-trust.png(unused since the hero redesign).Verification
docs/: 0 broken relative links.grepacrossapp/,components/,lib/).Follow-ups
txHashverification in/api/loans/fund,/api/pools/deposit,/api/loans/repay.activate_loan,record_payment, pooled lending; standalone contracts).🤖 Generated with Claude Code