Skip to content

docs: Create AGENTS.md#2275

Open
charlesvien wants to merge 5 commits into
mainfrom
05-20-refactor_docs
Open

docs: Create AGENTS.md#2275
charlesvien wants to merge 5 commits into
mainfrom
05-20-refactor_docs

Conversation

@charlesvien
Copy link
Copy Markdown
Member

@charlesvien charlesvien commented May 21, 2026

Split dev guide into AGENTS.md and reference docs

This is good to merge before refactor stuff, should help a little bit in the interim

Copy link
Copy Markdown
Member Author

charlesvien commented May 21, 2026

This stack of pull requests is managed by Graphite. Learn more about stacking.

@charlesvien charlesvien changed the title refactor docs refactor: The Master Plan May 21, 2026
@charlesvien charlesvien changed the title refactor: The Master Plan refactor: The Plan May 21, 2026
Comment thread AGENTS.md
@charlesvien charlesvien force-pushed the 05-20-refactor_docs branch from fa2b276 to a4a6afb Compare May 24, 2026 23:10
@charlesvien charlesvien force-pushed the 05-20-refactor_docs branch from a4a6afb to 01123c3 Compare May 25, 2026 22:05
@charlesvien charlesvien changed the title refactor: The Plan docs: Create AGENTS.md May 25, 2026
@charlesvien charlesvien marked this pull request as ready for review May 25, 2026 23:49
@charlesvien charlesvien added the Stamphog This will request an autostamp by stamphog on small changes label May 25, 2026
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 25, 2026

T-Rex T-Rex Logs

What T-Rex did

  • Ran a package dry-run for packages/agent to inspect the files that would be published.
  • Verified that packages/agent/package.json still declares CLAUDE.md in the published files list.
  • Verified there is no package-local CLAUDE.md, and the dry-run tarball contains no CLAUDE.md entry.
  • Verified the root CLAUDE.md symlink points to AGENTS.md, and noted that the root symlink is not part of the @posthog/agent publish output.
Artifacts

Package dry-run manifest for packages/agent

  • Helps verify the contents of the published manifest for packages/agent and what would be included in the tarball.

T-Rex Ran code and verified through T-Rex

Comments Outside Diff (2)

  1. apps/code/SCHEMA.md

    P2 Preserve analytics catalog

    Deleting this file drops the analytics event catalog and the “Adding a new event” checklist, but the new docs only keep the naming rules. When someone adds a tracked event, they no longer have the canonical place that explains which catalog row to update and what each existing event means, so the analytics docs can drift from ANALYTICS_EVENTS even though this PR is meant to split the guide into reference docs.

    Prompt To Fix With AI
    This is a comment left during a code review.
    Path: apps/code/SCHEMA.md
    Line: 86
    
    Comment:
    **Preserve analytics catalog**
    
    Deleting this file drops the analytics event catalog and the “Adding a new event” checklist, but the new docs only keep the naming rules. When someone adds a tracked event, they no longer have the canonical place that explains which catalog row to update and what each existing event means, so the analytics docs can drift from `ANALYTICS_EVENTS` even though this PR is meant to split the guide into reference docs.
    
    How can I resolve this? If you propose a fix, please make it concise.
  2. packages/agent/package.json, line 147 (link)

    P2 Declared doc not published

    packages/agent/package.json still whitelists CLAUDE.md, but no packages/agent/CLAUDE.md exists. The package dry-run succeeds silently and publishes a tarball without that file, so consumers of @posthog/agent will not receive the agent context file that the manifest still declares.

    Artifacts

    Package dry-run manifest showing no CLAUDE.md entry

    • Keeps the command output available without making the summary code-heavy.

    T-Rex Ran code and verified through T-Rex

Prompt To Fix All With AI
Fix the following 1 code review issue. Work through them one at a time, proposing concise fixes.

---

### Issue 1 of 1
apps/code/SCHEMA.md:86
**Preserve analytics catalog**

Deleting this file drops the analytics event catalog and the “Adding a new event” checklist, but the new docs only keep the naming rules. When someone adds a tracked event, they no longer have the canonical place that explains which catalog row to update and what each existing event means, so the analytics docs can drift from `ANALYTICS_EVENTS` even though this PR is meant to split the guide into reference docs.

Reviews (1): Last reviewed commit: "Update AGENTS.md" | Re-trigger Greptile

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Stamphog This will request an autostamp by stamphog on small changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants