Skip to content

docs: centralize SDK examples in official docs#228

Merged
marandaneto merged 2 commits into
mainfrom
docs/centralize-sdk-docs
Jun 12, 2026
Merged

docs: centralize SDK examples in official docs#228
marandaneto merged 2 commits into
mainfrom
docs/centralize-sdk-docs

Conversation

@marandaneto

@marandaneto marandaneto commented Jun 12, 2026

Copy link
Copy Markdown
Member

💡 Motivation and Context

SDK README and usage markdown files duplicated code snippets that can drift from the official documentation. This keeps public SDK usage examples in the official docs as the single source of truth while preserving local repository information like badges, Questions/community links, and example setup instructions.

💚 How did you test it?

  • Ran git diff --check.
  • Verified stale USAGE.md/old integration-doc links were removed or updated.
  • Verified existing badges and Questions/community sections are preserved.

📝 Checklist

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

If releasing new changes

  • Ran pnpm changeset to generate a changeset file

@github-actions

github-actions Bot commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

posthog-dotnet Compliance Report

Date: 2026-06-12 13:00:21 UTC
Duration: 634ms

⚠️ Some Tests Failed

2/16 tests passed, 14 failed


Feature_Flags Tests

⚠️ 2/16 tests passed, 14 failed

View Details
Test Status Duration
Request Payload.Request With Person Properties Device Id 48ms
Request Payload.Flags Request Uses V2 Query Param 24ms
Request Payload.Flags Request Hits Flags Path Not Decide 6ms
Request Payload.Flags Request Omits Authorization Header 5ms
Request Payload.Token In Flags Body Matches Init 5ms
Request Payload.Groups Round Trip 5ms
Request Payload.Groups Default To Empty Object 5ms
Request Payload.Person Properties Distinct Id Auto Populated When Caller Omits It 5ms
Request Payload.Disable Geoip False Propagates As Geoip Disable False 5ms
Request Payload.Disable Geoip Omitted Defaults To False 5ms
Request Payload.Flag Keys To Evaluate Contains Only Requested Key 5ms
Request Lifecycle.No Flags Request On Init Alone 4ms
Request Lifecycle.No Flags Request On Normal Capture 188ms
Request Lifecycle.Two Flag Calls Produce Two Remote Requests 6ms
Request Lifecycle.Mock Response Value Is Returned To Caller 5ms
Side Effect Events.Get Feature Flag Captures Feature Flag Called Event 6ms

Failures

request_payload.request_with_person_properties_device_id

404, message='Not Found', url='http://sdk-adapter:8080/get_feature_flag'

request_payload.flags_request_uses_v2_query_param

404, message='Not Found', url='http://sdk-adapter:8080/get_feature_flag'

request_payload.flags_request_hits_flags_path_not_decide

404, message='Not Found', url='http://sdk-adapter:8080/get_feature_flag'

request_payload.flags_request_omits_authorization_header

404, message='Not Found', url='http://sdk-adapter:8080/get_feature_flag'

request_payload.token_in_flags_body_matches_init

404, message='Not Found', url='http://sdk-adapter:8080/get_feature_flag'

request_payload.groups_round_trip

404, message='Not Found', url='http://sdk-adapter:8080/get_feature_flag'

request_payload.groups_default_to_empty_object

404, message='Not Found', url='http://sdk-adapter:8080/get_feature_flag'

request_payload.person_properties_distinct_id_auto_populated_when_caller_omits_it

404, message='Not Found', url='http://sdk-adapter:8080/get_feature_flag'

request_payload.disable_geoip_false_propagates_as_geoip_disable_false

404, message='Not Found', url='http://sdk-adapter:8080/get_feature_flag'

request_payload.disable_geoip_omitted_defaults_to_false

404, message='Not Found', url='http://sdk-adapter:8080/get_feature_flag'

request_payload.flag_keys_to_evaluate_contains_only_requested_key

404, message='Not Found', url='http://sdk-adapter:8080/get_feature_flag'

request_lifecycle.two_flag_calls_produce_two_remote_requests

404, message='Not Found', url='http://sdk-adapter:8080/get_feature_flag'

request_lifecycle.mock_response_value_is_returned_to_caller

404, message='Not Found', url='http://sdk-adapter:8080/get_feature_flag'

side_effect_events.get_feature_flag_captures_feature_flag_called_event

404, message='Not Found', url='http://sdk-adapter:8080/get_feature_flag'

@greptile-apps

greptile-apps Bot commented Jun 12, 2026

Copy link
Copy Markdown
Contributor
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
src/PostHog.AI/README.md:1-10
**Pre-release warning removed from NuGet README**

The old README carried a prominent warning block stating that `PostHog.AI` is pre-release, publicly available for feedback, and that there *will* be many breaking changes. This README is embedded in the NuGet package and displayed directly on nuget.org, so it is often the first (and only) thing a developer reads before deciding to take a dependency. With the stub replacement, that signal is gone entirely — a developer browsing NuGet would see nothing to indicate the stability status of the package.

Reviews (1): Last reviewed commit: "docs: centralize SDK examples in officia..." | Re-trigger Greptile

Comment thread src/PostHog.AI/README.md
@marandaneto
marandaneto force-pushed the docs/centralize-sdk-docs branch from 9ac2261 to d926a11 Compare June 12, 2026 12:13
Comment thread src/PostHog.AspNetCore/README.md Outdated
Comment thread README.md Outdated
@marandaneto
marandaneto marked this pull request as ready for review June 12, 2026 13:52
@marandaneto
marandaneto requested review from a team and haacked as code owners June 12, 2026 13:52
Comment thread src/PostHog.AI/README.md
## Configuration

The handler uses the configured `IPostHogClient` to send events. Ensure your PostHog client is correctly configured with your API key and host URL.
- [.NET AI observability docs](https://posthog.com/docs/libraries/dotnet#ai-observability)

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@greptile-apps

greptile-apps Bot commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Reviews (2): Last reviewed commit: "address pr review feedback" | Re-trigger Greptile

@marandaneto
marandaneto enabled auto-merge (squash) June 12, 2026 13:59
@marandaneto
marandaneto disabled auto-merge June 12, 2026 16:50
@marandaneto
marandaneto merged commit 93439d1 into main Jun 12, 2026
12 checks passed
@marandaneto
marandaneto deleted the docs/centralize-sdk-docs branch June 12, 2026 16:51
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