docs(web): add AGENTS.md — stack, commands, routing conventions, migration rules#31154
Conversation
…ration guidance Thin agent-specific reference that complements CONVENTIONS.md and STYLE_GUIDE.md. Covers stack overview, routing conventions (no basename, absolute paths matching platform), dev commands, and migration rules. Does NOT duplicate architectural or style conventions already documented in CONVENTIONS.md and STYLE_GUIDE.md — points to them instead. Co-Authored-By: ashlee@vellum.ai <ashlee@vellum.ai>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 04975e3e69
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
There was a problem hiding this comment.
✦ APPROVE
Value: Gives agents the minimal-but-precise context they need to work in apps/web/ without re-reading CONVENTIONS.md in full. Stack, commands, route architecture, and the migration contract in 47 lines. The pointer-based design (defer to CONVENTIONS.md / STYLE_GUIDE.md for depth) is the right call.
Content check:
- Stack entries accurate — Vite, React 19, React Router v7 data mode, Zustand, TanStack Query, HeyAPI plugin, Tailwind v4, Capacitor. ✅
- Commands correct —
bun install,bun run dev,bun run openapi-ts,bunx tsc --noEmit,bun test. Port 3001 documented. ✅ - Routing section matches post-#31141 architecture: no basename,
/account/*auth pages,/assistant/*app. ✅ - Migration contract is tight — "faithful copy, not simplification", Capacitor paths preserved, convention compliance on arrival, no marketing/admin. ✅
On Codex P2 (basename mismatch): Valid as a snapshot observation but not an error. This file documents the target state after PR #31141 (which I approved at 13:17) merges. Devin called it correctly. The dependency is merge order: #31141 must land first. Once it does, this file is accurate and there's no longer a mismatch.
CI: 3/3 green. ✅
One optional improvement (not blocking): Could add a one-liner under Routing pointing to src/lib/account/login-flow.ts as the source of PROVIDER_CALLBACK_URL and OAuth redirect constants — that's the file agents are most likely to touch during auth work and the one that caused the most churn in #31141. Easy to add in a follow-up if it surfaces as a gap.
Prompt / plan
Add
apps/web/AGENTS.md— a thin reference file that gives agents the essential context they need (stack, commands, routing conventions, migration rules) without duplicating the comprehensiveCONVENTIONS.mdandSTYLE_GUIDE.mdalready on main.What this adds
CONVENTIONS.mdandSTYLE_GUIDE.mdbefore making changescreateBrowserRouter), Zustand, TanStack Query, Tailwind CSS v4, Capacitor/account/*(auth pages, no app chrome) and/assistant/*(chat app withRootLayout→ChatLayout) as explicit top-level branchesWhat this does NOT do
CONVENTIONS.mdSTYLE_GUIDE.mdlib/and cross-domain import conventions in those filesDependency
Merge PR #31141 first. The routing section documents the post-#31141 architecture (no
basename,/account/*and/assistant/*as explicit top-level branches). Onmaintoday,routes.tsxstill usesbasename: "/assistant".Test plan
References
createBrowserRouter) and framework modeLink to Devin session: https://app.devin.ai/sessions/5c400920d2b745bc84401cd020820f22
Requested by: @ashleeradka