docs(readme): improve instructions

[Alejandroq12]

Summary by CodeRabbit

• Documentation
  • Clarified the app description, technology stack, setup process, and Node.js requirements.
  • Added guidance for environment-variable security and Vercel deployment.
  • Expanded documentation on architecture, accessibility, API behavior, filtering, notifications, and deployment.
  • Documented the code-generation workflow, rationale, implementation details, bonus features, and additional notes.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
task-flow	Ready	Preview	Aug 10, 2026 2:38pm

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 6935ba97-e27c-4cd6-9c72-77ed8b196c00

📥 Commits

Reviewing files that changed from the base of the PR and between 38677fb and 328dd87.

📒 Files selected for processing (1)

• README.md

🚧 Files skipped from review as they are similar to previous changes (1)

• README.md

---

📝 Walkthrough

Walkthrough

README.md was updated with clearer application, technology, setup, deployment, architecture, feature, accessibility, API, filtering, notification, and Node.js documentation.

Changes

README documentation

Layer / File(s)	Summary
Application and technology stack README.md	The README clarifies the app description, technology stack, CI/CD, Vercel integration, Node 24.14.1 requirement, and GraphQL code generation.
Setup and deployment documentation README.md	Setup and deployment instructions now cover generated code, environment variables, token security, HTTPS enforcement, Vercel proxy configuration, and the documented open-relay risk.
Architecture and feature documentation README.md	The README expands architecture rationale, data-fetching behavior, implemented features, animation and due-date rules, accessibility considerations, API behavior, filtering, notifications, and additional notes.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

• Alejandroq12/task-flow#41: Updates README.md with related deployment, environment-variable, architecture, and implementation documentation.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly identifies a README documentation update that improves the project's instructions.
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.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/complete-readme

---

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

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Line 36: Update both README instructions describing when to run code
generation so they include API schema changes alongside query and mutation
changes. Keep the existing environment-variable requirement and cloning/setup
guidance unchanged.

🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: cdd897a8-6aba-4c2e-b730-61b322fe9dac

📥 Commits

Reviewing files that changed from the base of the PR and between 86ae8c6 and 38677fb.

📒 Files selected for processing (1)

• README.md

[claude]

Code review

No issues found. Checked for bugs and CLAUDE.md compliance.

[stevenheffner]

Review summary

Context: I reviewed the full submission — code and deployed app.

Good work to name first: the serverless token proxy is real and verified — every GraphQL request goes to your own /graphql with no Authorization header in the browser; you were the only candidate who treated the API token as a secret. The URL-param validation before casts, the query key that includes the full filter input, dialog focus hooks with correct cleanup and focus-return, zero unnecessary effects, and zero stale-closure or index-key mistakes anywhere. The engineering process around the code — issues, kanban, CI per PR, Dependabot — reads like professional practice.

The most important fixes, in order:

1. Make success notifications visible (PR Feature/mutations #36) — the wiring exists; nothing renders.
2. Unify the mobile/desktop submit gates (PR Feature/mutations #36).
3. Guard the proxy's upstream fetch (PR Fix 404 error #34).
4. Replace the post-create DOM polling with a ref-driven scroll and cancel the timers (PR Feature/bonus points #39).

One consolidation: the invalidate + notify + close trio is repeated in CreateTaskModal, EditTaskModal, and DeleteTaskDialog — one useTaskMutation(document, messages) hook would hold the pattern in a single place. And the CreateTask/UpdateTask documents repeat the same nine-field selection set — a shared GraphQL fragment removes the drift risk.

[Alejandroq12]

@stevenheffner Thank you, Steven, really appreciate the detailed review. I'm in the middle of the backend track this week with things due tomorrow, so I'll start working through these four right after, beginning with the notifications. Will keep improving, delivering and putting the effort each day.