chore(docs): consolidate documentation and correct the README - #1329
Merged
Conversation
- Remove ~43 redundant root docs (per-issue *_IMPLEMENTATION/*_COMPLETE/ *_SUMMARY/PR_* write-ups and stray prompt/task files) already represented under docs/ - Move the genuinely-useful guides (deployment, offline mode, GraphQL subscriptions, web3, redirects, QR code, branch/PR guide, TODO) into docs/ - Remove stray package-lock.json (repo uses pnpm per packageManager) - Rewrite README to reflect the real product, stack, env vars, scripts, and the four-repo ecosystem
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
Cleans up the repository's documentation and brings the README in line with what the code actually is.
*_IMPLEMENTATION/*_COMPLETE/*_SUMMARY/PR_*write-ups plus strayprompt.md/task.md. Their content is already represented in the curateddocs/folder.docs/(deployment, offline mode, GraphQL subscriptions, web3 integration/testing, redirect management, QR code, branch/PR guide, TODO) — pure renames, history preserved.package-lock.json— the repo pinspnpm@10.33.2viapackageManagerand CI installs withpnpm --frozen-lockfileagainstpnpm-lock.yaml.README.mdto reflect the real product, the actual stack (Next.js 15 App Router client ofteachLink_backend; on-chain layer is Stellar/Soroban), real env vars andpnpmscripts, and the four-repo ecosystem. Removed the inaccurate Starknet/Argent/Braavos and wrong-org references.Root now contains only
README.mdandCONTRIBUTING.mdas markdown; no source or build behaviour changes.closes #1328