docs: fix .gitignore, architecture.md, add ADR folder and API reference - #126
Merged
dzekojohn4 merged 1 commit intoJul 25, 2026
Merged
Conversation
UnityChainxx#120 (gitignore, ADRs, api ref, architecture) Issue UnityChainxx#113 — Comprehensive root .gitignore - Expand root .gitignore from 5 lines to full coverage for Node/NestJS, Next.js, Rust/Cargo, IDEs, OS files, and secrets - Adds: .env*, target/, *.local, IDE files (.idea, .vscode/*), OS files (Thumbs.db), logs, coverage, temp dirs Issue UnityChainxx#118 — Fix docs/architecture.md to match reality - Backend module list pruned to modules actually registered in app.module.ts (removed aspirational/non-existent modules) - Added explicit note that LeaderboardModule does not exist; the leaderboard endpoint lives in StreakModule - Added note that @reduxjs/toolkit is a dependency but Zustand is the active state manager; links to ADR-0002 - Cross-referenced new docs/api.md and docs/adr/ folder Issue UnityChainxx#119 — Add docs/adr/ folder with starter ADRs - docs/adr/0001-record-architecture-decisions.md: ADR process + template - docs/adr/0002-zustand-alongside-redux-toolkit.md: why Zustand is primary - docs/adr/0003-nestjs-modular-monolith.md: why monolith over microservices - docs/adr/0004-soroban-over-evm.md: why Soroban/Stellar over EVM Issue UnityChainxx#120 — Create docs/api.md API reference table - Full endpoint reference derived from NestJS controller source - Columns: Method, Path, Auth, Description - Covers auth, users, puzzles, rewards, nft-claim, streak, time-trial, notifications, referrals, challenges, feedback, wallet, admin and all other registered controllers - Points to Swagger UI for live request/response schemas
|
@judithJn 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.
Summary
Resolves all four open issues assigned to @judithJn in a single docs-focused PR.
Closes #113 —
.gitignoredoesn't catch.env,target/, or IDE files.gitignorefrom 5 lines to comprehensive coverage.env/.env.*, Rusttarget/, IDE directories (.idea/,.vscode/*), OS files (.DS_Store,Thumbs.db), logs, coverage, temp dirs, Docker overridesCloses #118 —
docs/architecture.mdmisrepresents current stateapp.module.tsLeaderboardModuledoes not exist; the leaderboard endpoint is served byStreakModule@reduxjs/toolkitis a dependency but Zustand is the active state manager (links to new ADR-0002)docs/api.mdanddocs/adr/Closes #119 — Add an ADR folder
Created
docs/adr/with four starter ADRs:0001-record-architecture-decisions.md0002-zustand-alongside-redux-toolkit.md0003-nestjs-modular-monolith.md0004-soroban-over-evm.mdCloses #120 — API reference table for each public endpoint
Created
docs/api.mdwith a full endpoint reference table derived from the NestJS controller source:/api/docs) for full request/response schemasFiles Changed