You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
After this deletion, playgrounds/fastapi-exception-capture/ contains only app.py, pyproject.toml, and uv.lock — there is no README or USAGE file of any kind. The official docs URL added to the other READMEs points to the general AI observability installation guide, which does not describe how to start this specific playground or hit its test endpoint. A developer landing in this directory has no discoverable way to run it.
Prompt To Fix With AI
This is a comment left during a code review.
Path: playgrounds/fastapi-exception-capture/USAGE.md
Line: 1-18
Comment:
**Playground left with no documentation**
After this deletion, `playgrounds/fastapi-exception-capture/` contains only `app.py`, `pyproject.toml`, and `uv.lock` — there is no README or USAGE file of any kind. The official docs URL added to the other READMEs points to the general AI observability installation guide, which does not describe how to start this specific playground or hit its test endpoint. A developer landing in this directory has no discoverable way to run it.
How can I resolve this? If you propose a fix, please make it concise.
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
Prompt To Fix All With AI
Fix the following 3 code review issues. Work through them one at a time, proposing concise fixes.
---### Issue 1 of 3
README_ANALYTICS.md:1-9
**"Do not use this package" warning removed from PyPI description**`README_ANALYTICS.md` is used verbatim as the long description for the `posthoganalytics` PyPI package (see `setup_analytics.py` line 26: `config["project"]["readme"] = "README_ANALYTICS.md"`). The original content explicitly told PyPI visitors that this package is internal-only and that they should install `posthog` instead. The replacement content is entirely generic — nothing on the PyPI page will now warn a new user away from accidentally installing `posthoganalytics` thinking it is the right package.
### Issue 2 of 3
playgrounds/fastapi-exception-capture/USAGE.md:1-18
**Playground left with no documentation**
After this deletion, `playgrounds/fastapi-exception-capture/` contains only `app.py`, `pyproject.toml`, and `uv.lock` — there is no README or USAGE file of any kind. The official docs URL added to the other READMEs points to the general AI observability installation guide, which does not describe how to start this specific playground or hit its test endpoint. A developer landing in this directory has no discoverable way to run it.
### Issue 3 of 3
examples/example-ai-openai/README.md:1-10
**Per-example setup and run instructions removed with no equivalent in docs**
Every example README previously contained the `cp .env.example .env` / `uv sync` / `source .env` / `uv run python <script>.py` steps needed to actually execute the example. The linked docs URL (`https://posthog.com/docs/ai-observability/installation`) is a general SDK installation guide and does not describe how to clone and run these individual example scripts. This same pattern applies to all 35+ example READMEs changed in this PR.
Addressed the review feedback: restored README_ANALYTICS.md and README.md content in f2cd8a8, restored the FastAPI playground usage docs in f88b480, and the per-example README feedback is stale because the current PR no longer changes those files.
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
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
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?
git diff --check.USAGE.md/old integration-doc links were removed or updated.📝 Checklist
If releasing new changes
pnpm changesetto generate a changeset file