chore: refresh docs and eslint plugin

[harley]

Summary

• refresh README/AGENTS with current stack, workflows, and env keys
• update docs for implementation, testing, and Supabase test strategy
• clean up .env.example and pin Next ESLint plugin to resolve ESLint 9 config errors

Testing

• pnpm lint
• pnpm test:run

Summary by CodeRabbit

• Documentation

  • Streamlined and reorganized project documentation for improved clarity and accessibility.

• Chores

  • Restructured environment configuration sections for better organization.
  • Updated development tooling dependencies.

[vercel]

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

Project	Deployment	Actions	Updated (UTC)
pulse	Ready	Preview, Comment	Feb 3, 2026 6:00pm

[coderabbitai]

📝 Walkthrough

Walkthrough

The PR restructures configuration and documentation files to streamline setup and guidance. Environment variables are reorganized into logical sections (Email, AI, Analytics, Integrations), while multiple documentation files are rewritten with condensed content focused on essential information and local development workflows. An ESLint plugin dependency is added.

Changes

Cohort / File(s)	Summary
Environment Configuration .env.example	Reorganized sections with email, AI, and analytics variables relocated; removed Google Client ID and Bedrock AWS keys from original locations; added CORS domain, GA tracking, and email settings.
Documentation Restructuring AGENTS.md, README.md, docs/supabase-in-test.md, docs/test-plan.md	Comprehensive simplification of documentation: AGENTS.md condensed to operational guide; README collapsed from feature-heavy to high-level overview; testing docs reduced to essential Supabase and configuration notes.
Implementation Guide docs/implementation.md	Rewritten to reflect modernized stack (Next.js 15, React 19, Tailwind CSS 4) with restructured sections covering app architecture, authentication, data model, AI endpoints, and email handling.
Dependencies package.json	Added devDependency @next/eslint-plugin-next version 15.3.1 for Next.js linting support.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

• feat: update README #152: Overlapping README.md restructuring and content consolidation changes.
• Add AGENTS guidelines #99: AGENTS.md rewrite and simplification of agent documentation.
• feat: setup local supabase #32: Related .env.example reorganization and environment variable restructuring.

Suggested labels

codex

Poem

🐰 ✨ A rabbit hops through docs so neat,
Configs bundled, docs repeat—
Shorter guides and clearer views,
Environment grouped in cleaner hues!

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'chore: refresh docs and eslint plugin' accurately reflects the main changes: documentation updates (README, AGENTS, implementation guides, test plans) and adding the Next ESLint plugin to package.json.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch codex/docs-refresh

Important

Action Needed: IP Allowlist Update

If your organization protects your Git platform with IP whitelisting, please add the new CodeRabbit IP address to your allowlist:

• ✨ 136.113.208.247/32 (new)
• 34.170.211.100/32
• 35.222.179.152/32

Reviews will stop working after February 8, 2026 if the new IP is not added to your allowlist.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[gemini-code-assist]

Summary of Changes

Hello @harley, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request primarily focuses on bringing the project's documentation up-to-date and improving the developer experience. It streamlines various README and docs files to accurately reflect the current technology stack, development commands, and testing strategies. Additionally, it refines the example environment file for better clarity and addresses an ESLint configuration problem by specifying a compatible plugin version.

Highlights

• Documentation Refresh: Updated README.md, AGENTS.md, docs/implementation.md, docs/supabase-in-test.md, and docs/test-plan.md to reflect the current project stack, workflows, and environment variable usage.
• Environment Configuration Clarity: The .env.example file has been reorganized, commented, and updated with current and relevant environment variables, removing outdated ones and adding new ones like HR_EMAIL and NEXT_PUBLIC_GA_ID.
• ESLint Configuration Fix: Pinned the @next/eslint-plugin-next dependency to version 15.3.1 in package.json to resolve compatibility issues with ESLint 9.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

• .env.example
  • Reorganized variables into logical sections with comments (Supabase, App, Auth/tokens, Email, AI, LangSmith, Integrations/misc, Analytics).
  • Removed NEXT_PUBLIC_GOOGLE_CLIENT_ID.
  • Added HR_EMAIL, NEXT_PUBLIC_ENABLE_EMAILS, BEDROCK_AWS_REGION, and NEXT_PUBLIC_GA_ID.
  • Updated SUPABASE_SERVICE_ROLE_KEY default value.
• AGENTS.md
  • Rewrote the introductory project description.
  • Consolidated and updated development commands.
  • Expanded local Supabase setup details, including local service URLs.
  • Provided a comprehensive list of environment variables with descriptions.
  • Simplified code conventions and added key project locations.
  • Condensed testing notes and documentation guidance.
• README.md
  • Significantly shortened and updated the project overview.
  • Refined the "Stack" and "Core Areas" sections.
  • Simplified local development instructions and scripts.
  • Updated testing and environment notes.
  • Streamlined the project structure description.
• docs/implementation.md
  • Updated the "Stack (Current)" section to reflect Next.js 15, React 19, Tailwind 4, and AI features.
  • Simplified "App Structure", "Auth", "Data Model", "AI", "Email", and "Cron" sections, removing outdated or overly detailed content.
  • Added references to other relevant documentation files.
• docs/supabase-in-test.md
  • Drastically condensed the document to focus on the default testing approach (mocks for unit/integration, local Supabase for E2E).
  • Provided a concise example of Supabase mock setup.
  • Removed extensive comparisons of testing approaches, best practices, and detailed implementation examples.
• docs/test-plan.md
  • Simplified the document to focus on the testing stack, file locations, configuration, commands, Supabase strategy, and Playwright MCP requirement.
  • Removed detailed directory structure, test categories, authentication strategy, CI/CD integration, implementation plan, code coverage goals, and best practices.
• package.json
  • Added @next/eslint-plugin-next dependency with a pinned version of 15.3.1.
• pnpm-lock.yaml
  • Updated to reflect the addition of @next/eslint-plugin-next@15.3.1.

Activity

• The author has refreshed various documentation files (README.md, AGENTS.md, docs/implementation.md, docs/supabase-in-test.md, docs/test-plan.md) to align with the current project state.
• The .env.example file has been cleaned up and reorganized for better clarity and completeness.
• The @next/eslint-plugin-next dependency was explicitly pinned to version 15.3.1 to address ESLint 9 configuration errors.
• The author has indicated that pnpm lint and pnpm test:run were used for testing, suggesting that the changes pass existing linting rules and unit tests.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request provides a great refresh for the project's documentation, making it much more concise and up-to-date. The changes in README.md, AGENTS.md, and the docs folder significantly improve clarity for developers. The cleanup of .env.example and the fix for the ESLint plugin in package.json are also valuable improvements. I have one suggestion regarding a weak default password in the example environment file to enhance security practices.

[gemini-code-assist]

The example TEST_USER_PASSWORD is a concrete but weak password. This is inconsistent with other secrets in this file which use placeholders like your-secure-secret. Using a weak default password encourages poor security practices, as it might be copied for local or staging environments. It's better to use a placeholder to prompt the developer to set a secure password.

TEST_USER_PASSWORD=your-strong-test-password