Skip to content

docs: overhaul README and remove TEMPLATE_STATUS#69

Merged
GRACENOBLE merged 3 commits into
mainfrom
readme-and-cleanup
Jun 25, 2026
Merged

docs: overhaul README and remove TEMPLATE_STATUS#69
GRACENOBLE merged 3 commits into
mainfrom
readme-and-cleanup

Conversation

@GRACENOBLE

@GRACENOBLE GRACENOBLE commented Jun 25, 2026

Copy link
Copy Markdown
Owner

Summary

  • README overhaul — corrects stale prerequisites (Go 1.25+, Node.js 22+), fixes .env.example references, updates project structure to match actual clean-architecture layout, expands env var table with link to RUNBOOK.md, adds all make lint/swagger/migrate-* commands, Spotless Gradle targets, quick-start via setup.sh/dev.sh, and links to ADRs and RUNBOOK in the Contributing section
  • Delete TEMPLATE_STATUS.md — all 21 readiness gaps (fix(backend): make CORS origin a config value instead of hardcoded localhost:3000 #44docs(infra): add deployment runbook for staging and production #64) are resolved and merged; the file served its purpose
  • setup.ps1 — Android SDK detection — script now falls back to %LOCALAPPDATA%\Android\Sdk when ANDROID_HOME is not set as an explicit env var (Android Studio installs there by default but does not always set the variable); prints a one-liner to set it permanently if missing
  • dev.ps1 + setup.ps1 — PowerShell execution policy — spawned child windows now receive -ExecutionPolicy Bypass so npm-installed script wrappers like pnpm.ps1 run without a SecurityError on machines with Restricted policy

No backend or web code changes.

README updates:
- Prerequisites: Go 1.25+, Node.js 22+ (were 1.21/20)
- Installation: reference .env.example (not .env.local)
- Added quick-start via setup.sh/dev.sh
- Project structure updated to match actual clean-architecture layout
- Environment variables: expanded table, link to RUNBOOK.md for full list
- Dev commands: added make lint, swagger, all migrate-* targets, Spotless
- Added ADR and RUNBOOK links in Contributing section
- Tech stack: accurate versions, Firebase Auth, Redis/Asynq, correct test tooling

TEMPLATE_STATUS.md removed — all 21 issues resolved and merged.
@coderabbitai

coderabbitai Bot commented Jun 25, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

README.md was reorganized and expanded across overview, setup, reference, command, testing, and contribution sections. TEMPLATE_STATUS.md was removed.

Changes

README refresh

Layer / File(s) Summary
Overview and navigation
README.md
The opening description and table of contents were updated to match the new section layout.
Setup and environment
README.md
Getting started instructions, project structure details, and environment variable guidance were expanded.
Commands and testing
README.md
Development commands, testing guidance, and agent workflow text were updated.
Governance links
README.md
An architecture decisions section was added and the contributing text was replaced with linked references.

Template status cleanup

Layer / File(s) Summary
Status document removal
TEMPLATE_STATUS.md
The template readiness status content and its metadata lines were deleted.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I hopped through the README, neat and bright,
Reordered the burrows from left to right.
The status page fluttered away in the breeze,
While setup and commands rustled the trees.
Thump-thump! said the rabbit, “docs feel just right.”

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the two main documentation changes: a README overhaul and removal of TEMPLATE_STATUS.md.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch readme-and-cleanup

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

ANDROID_HOME is often not set as an explicit env var even when Android
Studio is installed — the SDK lives at the predictable path
%LOCALAPPDATA%\Android\Sdk. Fall back to that location before failing,
and surface a one-liner to set the variable permanently for users who
want full tooling compatibility.
Child powershell processes inherit the Restricted execution policy,
which blocks pnpm.ps1 and other npm-installed script wrappers.
Bypass applies only to those child windows and does not change the
machine or user policy.
@GRACENOBLE GRACENOBLE merged commit 3c0a856 into main Jun 25, 2026
2 checks passed
@GRACENOBLE GRACENOBLE deleted the readme-and-cleanup branch June 25, 2026 14:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant