docs: Refresh and simplify SDK agent guidance - #340
Merged
Merged
Conversation
Contributor
|
[Low risk] Updates guidance text for SDK contributors and agents. The documentation change appears safe to merge. Reviews (1) · Last reviewed commit: "docs: Refresh and simplify SDK agent gui..." |
Contributor
posthog-dotnet Compliance ReportDate: 2026-10-05T08:50:21.190074+00:00 ✅ All Tests Passed!47/47 tests passed Capture Tests✅ 30/30 tests passed View Details
Feature_Flags Tests✅ 17/17 tests passed View Details
|
marandaneto
marked this pull request as ready for review
October 5, 2026 08:54
dustinbyrne
approved these changes
Oct 5, 2026
marandaneto
deleted the
docs/refresh-agent-instructions-20261002-133550
branch
October 5, 2026 15:17
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 review rule can incorrectly flag an external API change that already has an API-defining published SDK spec. The contributor-guide inventory also repeats guidance available through its link.
Clarify that an API-defining published SDK spec satisfies the external contributor review agreement. Remove the contributor-guide section inventory while retaining maintainer verification, issue consent, and changed-behavior-only spec checks.
💚 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. 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
pnpm changesetto 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. Useful details were moved to focused local guides rather than deleted. Human review is still required. No public session link is available.