docs(devex): symlink CLAUDE.md to AGENTS.md, steer agents to keep docs current#31
Conversation
CLAUDE.md as a symlink means Claude Code picks up the same guidance as other agents without maintaining two files. AGENTS.md additions: a section making doc updates part of the change itself (env vars -> README config table, persistence changes -> README architecture section, design changes -> the design brief) and a short note that tests exist now and should be extended when touching persistence or purge code. Design brief and repo guidelines were verified against the current frontend and left unchanged. Generated-By: PostHog Code Task-Id: 41462379-8751-40f7-b68c-dfe5dc89d1b8
|
@codex review |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 8c0527902f
ℹ️ About Codex in GitHub
Your team has set up Codex to 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 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| @@ -0,0 +1 @@ | |||
| AGENTS.md No newline at end of file | |||
There was a problem hiding this comment.
In checkouts where Git sets core.symlinks=false (for example, filesystems without symlink support), Git documents that symlinks are checked out as “small plain files that contain the link text,” so this CLAUDE.md would contain only AGENTS.md instead of the actual instructions. Because this file exists specifically so Claude Code reads the repo guidance, those contributors would silently miss the docs/test/design rules; consider making CLAUDE.md a real Markdown file or another format the tool expands explicitly.
Useful? React with 👍 / 👎.
1 participant
CLAUDE.md is now a symlink to AGENTS.md so Claude Code reads the same guidance as other agents — one file to maintain.
While at it, checked AGENTS.md against the current code: the design brief (tokens, layout dimensions, typography, SSE events, data layer) and the public-repo guidelines all still match, so they're untouched. Two gaps filled:
FYI the README itself has some drift (config table missing a few newer env vars, SQLite section predates partitioning) — that's a separate pass, currently held back to avoid colliding with in-flight work touching the same table.
Created with PostHog Code