Summary
The documentation describes a project that doesn't exist, and what does exist is scattered across 15 markdown files at the repo root. A new contributor following the README will fail at step 1. Separately, the README badge claims MIT license but there is no LICENSE file — which means the project is legally not open source yet and contributors have no license covering their submissions.
Problems
1. README describes a fictional stack. The README says the frontend is "Next.js 14 with React 18, Tailwind, NextAuth.js, Zustand" and the backend uses "PostgreSQL with Prisma, Redis, Privy custodial wallets". In reality:
- There is no
frontend/ directory; the app is vanilla HTML/CSS/JS (index.html, game.html, game.js, styles.css)
- The Quick Start says
cd backend && npm install && npm run dev — backend/server.js crashes on startup (missing route modules), and the real entry point is root server.js via npm start
- It links to
docs/DEPLOYMENT.md, docs/API.md, docs/WEB3_INTEGRATION.md, docs/GRANT_COMPLIANCE.md — only docs/DEPLOYMENT.md exists
- It cites unverifiable claims as fact ("Ethereum Foundation grant recipient", "Average 23% improvement", "Audited smart contracts") — these should be removed or clearly marked as goals
- It points to a different repo entirely (
github.com/spellbloc/platform) and even a different project name (SpellBloc vs. Wordbloc)
2. 15 overlapping root-level docs: README.md, README-WORLDCLASS.md, SETUP.md, DEPLOYMENT_DEMO.md, DEPLOYMENT_INSTRUCTIONS.md, FINAL_DEPLOYMENT_STATUS.md, DOMAIN_SETUP.md, PROJECT_STRUCTURE.md, SPELLBLOC_PRD.md, WEB3_ARCHITECTURE.md, WEB3_FEATURES.md, CELO_PROOF_OF_SHIP.md, AI_AGENT_DOCUMENTATION.md, CURRICULUM.md, LANGUAGE-TESTING.md. Several contradict each other about how to deploy and run the app.
3. No LICENSE file despite the MIT badge and "license": "MIT" in package.json.
Proposed fix
Acceptance criteria
- A newcomer can clone, install, and run the game following only README.md
- Every link in README.md resolves
- ≤ 2 markdown files remain at the repo root (README + CONTRIBUTING)
LICENSE exists and matches the declared license
Summary
The documentation describes a project that doesn't exist, and what does exist is scattered across 15 markdown files at the repo root. A new contributor following the README will fail at step 1. Separately, the README badge claims MIT license but there is no LICENSE file — which means the project is legally not open source yet and contributors have no license covering their submissions.
Problems
1. README describes a fictional stack. The README says the frontend is "Next.js 14 with React 18, Tailwind, NextAuth.js, Zustand" and the backend uses "PostgreSQL with Prisma, Redis, Privy custodial wallets". In reality:
frontend/directory; the app is vanilla HTML/CSS/JS (index.html,game.html,game.js,styles.css)cd backend && npm install && npm run dev—backend/server.jscrashes on startup (missing route modules), and the real entry point is rootserver.jsvianpm startdocs/DEPLOYMENT.md,docs/API.md,docs/WEB3_INTEGRATION.md,docs/GRANT_COMPLIANCE.md— onlydocs/DEPLOYMENT.mdexistsgithub.com/spellbloc/platform) and even a different project name (SpellBloc vs. Wordbloc)2. 15 overlapping root-level docs:
README.md,README-WORLDCLASS.md,SETUP.md,DEPLOYMENT_DEMO.md,DEPLOYMENT_INSTRUCTIONS.md,FINAL_DEPLOYMENT_STATUS.md,DOMAIN_SETUP.md,PROJECT_STRUCTURE.md,SPELLBLOC_PRD.md,WEB3_ARCHITECTURE.md,WEB3_FEATURES.md,CELO_PROOF_OF_SHIP.md,AI_AGENT_DOCUMENTATION.md,CURRICULUM.md,LANGUAGE-TESTING.md. Several contradict each other about how to deploy and run the app.3. No LICENSE file despite the MIT badge and
"license": "MIT"inpackage.json.Proposed fix
LICENSEfile (MIT, matching package.json) — this is a 2-minute good-first-issue-sized task on its ownREADME.mdto describe the actual app: vanilla JS PWA + Express server + Hardhat/Celo contracts; accurate Quick Start (npm install && npm start); remove or clearly label aspirational contentdocs/(architecture, deployment, curriculum, PRD) and delete stale status files (FINAL_DEPLOYMENT_STATUS.md,DEPLOYMENT_DEMO.md,README-WORLDCLASS.md)Acceptance criteria
LICENSEexists and matches the declared license