docs: Refresh and simplify SDK agent guidance - #1006
Merged
marandaneto merged 3 commits intoOct 6, 2026
Merged
Conversation
Contributor
|
[Low risk] Updates SDK agent and contributor guidance documentation. The PR appears safe to merge, though the existing release-artifact guidance should be corrected. Reviews (2) · Last reviewed commit: "docs: Remove redundant capture protocol ..." |
Contributor
posthog-python Compliance ReportDate: 2026-10-05T10:41:30.481470+00:00 ✅ All Tests Passed!121/121 tests passed Capture_V1 Tests✅ 95/95 tests passed View Details
Capture_Ai Tests✅ 5/5 tests passed View Details
Feature_Flags Tests✅ 17/17 tests passed View Details
Feature_Flags_Local_Evaluation Tests✅ 4/4 tests passed View Details
|
marandaneto
marked this pull request as ready for review
October 5, 2026 10:15
dustinbyrne
approved these changes
Oct 5, 2026
marandaneto
deleted the
docs/refresh-agent-instructions-20261002-133550
branch
October 6, 2026 04:37
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
💡 Motivation and Context
The agent instructions contain stale references or repeat details maintained elsewhere. Keep repository-specific safeguards and make the instructions easier to use for focused SDK changes.
Shorten AGENTS.md while retaining the key capture, retry, compression, drop, and backoff safeguards. Direct capture changes to the implementation and tests instead of maintaining a separate protocol guide. Centralize validation and provider guidance in CONTRIBUTING.md. Correct the uv sources configuration name and warn that make prep_local deletes and recreates the sibling local mirror. Warn that make build_release_analytics clears dist/ and require publishing or preserving posthog artifacts first.
The capture-protocol document introduced earlier in this PR has been removed. The final diff only changes AGENTS.md and CONTRIBUTING.md.
💚 How did you test it?
Checked local Markdown links, exact Git path casing, anchors, code fences, whitespace, changed-file scope, and preservation of the API approval and scoped spec-review rules. Verified the artifact warning against the Makefile and release workflow without running destructive build targets. SDK runtime builds and tests were not run for this documentation-only change. Autoreview was skipped because every changed file is documentation.
📝 Checklist
No SDK code changes. Runtime tests and release changesets are not needed for this documentation-only PR.
If releasing new changes
sampo addto generate a changeset fileNot applicable. This PR does not release SDK changes.
🤖 Agent context
Autonomy: Human-driven (agent-assisted)
Tools: Pi, Git, and GitHub CLI. The SDK-wide documentation audit used Pi subagents for implementation and independent reviews. The human driver approved the audit and simplification plan, then requested removing the separate capture protocol reference. Core capture safeguards remain in AGENTS.md. Human review is still required. No public session link is available.