docs: refresh README (stack, contracts, roadmap, status) - #267
Merged
Conversation
…t_Save The README badge, clone URL, issue/discussion links, and the footer all pointed at the personal Sendi0011/Joint_Save repo, matching the same provenance mix-up seen in the Vercel project link. Point every repository reference at the canonical JointSave-org/Joint_Save so contributors fork, submit issues, and check CI against the right repo.
The README advertised Next.js 14 and npm, but the codebase and CI run Next.js 16, React 19 and pnpm (the packageManager field pins pnpm, and every workflow uses pnpm install --frozen-lockfile). Update the stack section, prerequisites and quick start so setup instructions match how the repo is actually built, tested and deployed.
Add badges for the frontend unit-test and Playwright E2E workflows so the header reflects all automated checks (deploy.yml stays badge-less as it is manual-only), and correct the Deployed Contracts section: the repo ships 8 contracts but only factory + rotational/target/flexible WASM have recorded testnet deployments. Clarify that governance/microloan/yield-strategy have no recorded deployment and that microloan/reputation are feature-gated via their NEXT_PUBLIC_*_CONTRACT_ID env vars.
…work Phase 1 is complete — mark reputation, microloan, DAO governance, USDC/ multi-token (SEP-41) with CCTP, flexible scheduling, push notifications, pool health, archival, disputes, and incident-response as shipped. Rescope Phase 2 to the actual remaining work (DeFi liquidity wiring for the scaffolded yield-strategy contract, protocol-wide analytics, group messaging, mainnet hardening for the unrecorded governance/microloan/ yield-strategy deployments, and the admin emergency console) and move mainnet deployment out of Phase 3, which now focuses on fiat rails, social features, and native mobile.
Replace the stale four-contract description with the real lightweight on-chain/off-chain split (factory + pool + supporting contracts, Next.js frontend, Supabase, incident-response safeguards), and add a Current Status section that honestly states what is deployed to testnet, that governance/ microloan/yield-strategy have no recorded deployment, the Vercel re-link situation, the four CI workflows, and open gaps tracked in issues #261/#263.
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.
Refreshes the README to reflect the current state of the repo. Chain of 5 focused commits:
Sendi0011/Joint_Saverefs (badge, clone, issues, discussions, footer) + 2 in ARCHITECTURE.md point toJointSave-org/Joint_Savefrontend/package.jsonand the pnpm-managed repoNo product code or config changed — docs only. All new links verified to resolve; the 2 broken links that remain (LICENSE,
docs/transactions-screenshot.png) pre-date this branch.Closes: none (docs only)