Skip to content

docs: Refresh and simplify SDK agent guidance - #355

Merged
marandaneto merged 2 commits into
mainfrom
docs/refresh-agent-instructions-20261002-133550
Oct 5, 2026
Merged

marandaneto merged 2 commits into
mainfrom
docs/refresh-agent-instructions-20261002-133550

Conversation

@marandaneto

@marandaneto marandaneto commented Oct 5, 2026 •

Copy link
Copy Markdown
Member

💡 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.

Clarify the published-spec review exemption and remove duplicated contributor-guide descriptions. Document separate checks for the root, otel, and posthogmcpsdk modules, including temporary-copy checks against the pinned released core SDK. Specify GOFLAGS=-mod=mod for both pinned-core build and vet, matching CI while keeping checksum changes out of the checkout.

💚 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 pinned-core commands against the CI workflow. SDK runtime builds and tests were not run for this documentation-only change. Autoreview was skipped because every changed file is documentation.

📝 Checklist

  • I reviewed the submitted changes.
  • I added tests to verify the changes.
  • I updated the docs if needed.
  • No breaking change or entry added to the changelog.

No SDK code changes. Runtime tests and release changesets are not needed for this documentation-only PR.

If releasing new changes

  • Ran pnpm changeset to generate a changeset file

Not 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.

@marandaneto marandaneto self-assigned this Oct 5, 2026
@greptile-apps

greptile-apps Bot commented Oct 5, 2026 •

Copy link
Copy Markdown
Contributor

Retrigger

[Low risk] Updates developer guidance and documentation.

The PR appears safe to merge, though the pinned-core check should be made reproducible for contributors.

Reviews (1) · Last reviewed commit: "docs: Refresh and simplify SDK agent gui..."

Comment thread CONTRIBUTING.md Resolved
@github-actions

github-actions Bot commented Oct 5, 2026 •

Copy link
Copy Markdown
Contributor

posthog-go Compliance Report

Date: 2026-10-05 10:39:25 UTC
Duration: 169120ms

✅ All Tests Passed!

111/111 tests passed


Capture_V1 Tests

✅ 94/94 tests passed

View Details
Test Status Duration
Endpoint And Method.Targets V1 Endpoint ✅ 44ms
Endpoint And Method.Does Not Use Legacy Endpoints ✅ 6ms
Required Headers.Has Authorization Bearer Header ✅ 6ms
Required Headers.Has Content Type Json ✅ 5ms
Required Headers.Has Posthog Sdk Info Format ✅ 5ms
Required Headers.Has Posthog Attempt Header ✅ 6ms
Required Headers.Has Posthog Request Id ✅ 6ms
Required Headers.Has Posthog Request Timestamp ✅ 5ms
Required Headers.Has User Agent ✅ 6ms
Body Format.Body Has Created At And Batch ✅ 5ms
Body Format.No Api Key In Body ✅ 6ms
Body Format.No Sent At In Body ✅ 6ms
Event Format.Event Has Required Root Fields ✅ 5ms
Event Format.Event Uuid Is Valid ✅ 5ms
Event Format.Event Timestamp Is Rfc3339 ✅ 6ms
Event Format.Distinct Id Is String ✅ 6ms
Event Format.Distinct Id At Root Not Properties ✅ 5ms
Event Format.Custom Properties Preserved ✅ 5ms
Event Format.Set Properties Preserved ✅ 5ms
Event Format.Set Once Properties Preserved ✅ 5ms
Event Format.Groups Properties Preserved ✅ 6ms
Event Format.Sdk Generates Uuid If Not Provided ✅ 5ms
Event Format.Event Has Required Root Fields Batch ✅ 7ms
Event Format.Event Uuid Is Valid Batch ✅ 8ms
Event Format.Event Timestamp Is Rfc3339 Batch ✅ 7ms
Event Format.Distinct Id Is String Batch ✅ 7ms
Event Format.Distinct Id At Root Not Properties Batch ✅ 19ms
Event Format.Custom Properties Preserved Batch ✅ 7ms
Event Format.Set Properties Preserved Batch ✅ 18ms
Event Format.Set Once Properties Preserved Batch ✅ 7ms
Event Format.Groups Properties Preserved Batch ✅ 7ms
Event Format.Sdk Generates Uuid If Not Provided Batch ✅ 9ms
Batch Behavior.Multiple Events In Single Batch ✅ 29ms
Batch Behavior.Batch Envelope Smoke ✅ 18ms
Batch Behavior.Flush With No Events Sends Nothing ✅ 4ms
Batch Behavior.Flush At Triggers Batch ✅ 1006ms
Batch Behavior.Created At Reflects Batch Creation Time ✅ 8ms
Deduplication.Generates Unique Uuids ✅ 14ms
Deduplication.Different Events Same Content Different Uuids ✅ 7ms
Deduplication.Preserves Uuid On Retry ✅ 5132ms
Deduplication.Preserves Timestamp On Retry ✅ 5136ms
Deduplication.Preserves Uuid And Timestamp On Batch Retry ✅ 5136ms
Deduplication.No Duplicate Events In Batch ✅ 30ms
Header Behavior On Retry.Attempt Header Starts At One ✅ 7ms
Header Behavior On Retry.Attempt Header Increments On Retry ✅ 10132ms
Header Behavior On Retry.Request Id Preserved On Retry ✅ 5135ms
Header Behavior On Retry.Different Requests Have Different Request Ids ✅ 2014ms
Header Behavior On Retry.Request Timestamp Changes On Retry ✅ 5135ms
Response Format Validation.Success Response Has Uuid Keyed Results ✅ 17ms
Response Format Validation.Success Response Has Ok For Each Event ✅ 28ms
Response Format Validation.Success No Retry After When All Ok ✅ 27ms
Response Format Validation.Success Retry After Present When Retry Events ✅ 129ms
Response Format Validation.Success No Retry After When Drop Only ✅ 27ms
Response Format Validation.Response Echoes Request Id ✅ 6ms
Retry Behavior.Retries On 408 ✅ 5134ms
Retry Behavior.Retries On 500 ✅ 5136ms
Retry Behavior.Retries On 503 ✅ 5136ms
Retry Behavior.Retries On 504 ✅ 5135ms
Retry Behavior.Retryable Errors Have Retry After ✅ 2132ms
Retry Behavior.Respects Retry After On Retryable Error ✅ 8139ms
Retry Behavior.Does Not Retry On 400 ✅ 2132ms
Retry Behavior.Does Not Retry On 401 ✅ 2132ms
Retry Behavior.Does Not Retry On 402 ✅ 2133ms
Retry Behavior.Does Not Retry On 413 ✅ 2132ms
Retry Behavior.Does Not Retry On 415 ✅ 2132ms
Retry Behavior.Non Retryable Errors Have No Retry After ✅ 2133ms
Retry Behavior.Implements Backoff ✅ 15142ms
Retry Behavior.Max Retries Respected ✅ 15145ms
Partial Batch Handling.Handles 200 Full Success ✅ 2019ms
Partial Batch Handling.Handles 200 With All Ok ✅ 3032ms
Partial Batch Handling.Does Not Retry Dropped Events ✅ 3029ms
Partial Batch Handling.Does Not Retry Limited Events ✅ 3029ms
Partial Batch Handling.Prunes Ok Events On Partial Retry ✅ 5133ms
Partial Batch Handling.Prunes Dropped Events On Partial Retry ✅ 5134ms
Partial Batch Handling.Retries Only Retry Events From Partial ✅ 5133ms
Partial Batch Handling.Partial Retry Preserves Uuids ✅ 5135ms
Partial Batch Handling.Partial Retry Attempt Header Increments ✅ 5136ms
Partial Batch Handling.Partial Retry Request Id Preserved ✅ 5135ms
Partial Batch Handling.Respects Retry After On Partial ✅ 5135ms
Partial Batch Handling.Unknown Result Treated As Terminal ✅ 3031ms
Partial Batch Handling.Mixed Ok Drop Limited No Retry ✅ 3032ms
Compression.Sends Gzip Content Encoding ✅ 7ms
Compression.No Content Encoding When Disabled ✅ 5ms
Compression.Compressed Body Is Decompressible ✅ 16ms
Error Handling.Does Not Retry On Unknown 4Xx ✅ 2131ms
Event Options.Cookieless Mode Override ✅ 17ms
Event Options.Disable Skew Correction Override ✅ 6ms
Event Options.Process Person Profile Override ✅ 6ms
Event Options.Product Tour Id Override ✅ 4ms
Event Options.Unset Options Omitted ✅ 5ms
Event Options.Options Override In Batch ✅ 8ms
Geoip And Historical Migration.Geoip Disable Injected Into Properties ✅ 5ms
Geoip And Historical Migration.Historical Migration Set In Body ✅ 5ms
Geoip And Historical Migration.Historical Migration Absent By Default ✅ 6ms

Feature_Flags Tests

✅ 17/17 tests passed

View Details
Test Status Duration
Request Payload.Request With Person Properties Device Id ✅ 14ms
Request Payload.Flags Request Uses V2 Query Param ✅ 15ms
Request Payload.Flags Request Hits Flags Path Not Decide ✅ 16ms
Request Payload.Flags Request Omits Authorization Header ✅ 15ms
Request Payload.Token In Flags Body Matches Init ✅ 15ms
Request Payload.Groups Round Trip ✅ 15ms
Request Payload.Groups Default To Empty Object ✅ 16ms
Request Payload.Disable Geoip False Propagates As Geoip Disable False ✅ 15ms
Request Payload.Disable Geoip Omitted Defaults To False ✅ 16ms
Request Payload.Flag Keys To Evaluate Contains Only Requested Key ✅ 14ms
Request Lifecycle.No Flags Request On Init Alone ✅ 3ms
Request Lifecycle.No Flags Request On Normal Capture ✅ 5ms
Request Lifecycle.Two Flag Calls Produce Two Remote Requests ✅ 27ms
Request Lifecycle.Mock Response Value Is Returned To Caller ✅ 16ms
Retry Behavior.Retries Flags On 502 ✅ 16ms
Retry Behavior.Retries Flags On 504 ✅ 16ms
Side Effect Events.Get Feature Flag Captures Feature Flag Called Event ✅ 16ms

@marandaneto
marandaneto marked this pull request as ready for review October 5, 2026 08:54
@marandaneto
marandaneto requested a review from a team as a code owner October 5, 2026 08:54
@marandaneto
marandaneto merged commit 58786e6 into main Oct 5, 2026
35 checks passed
@marandaneto
marandaneto deleted the docs/refresh-agent-instructions-20261002-133550 branch October 5, 2026 15:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants