Skip to content

docs: centralize SDK examples in official docs#164

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

docs: centralize SDK examples in official docs#164
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

@greptile-apps

greptile-apps Bot commented Jun 12, 2026

Copy link
Copy Markdown
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
README.md:1
**CI badge removed beyond stated PR scope**

The PR description focuses on removing duplicated code snippets, but the CI status badge (`[![CI](https://github.com/PostHog/posthog-php/actions/workflows/php.yml/badge.svg)](…)`) and the PHP version badge were also dropped. These badges give contributors an at-a-glance signal about build health without requiring a click through to GitHub Actions; their removal is unrelated to centralising documentation examples and may have been accidental.

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

Comment thread README.md
@marandaneto marandaneto force-pushed the docs/centralize-sdk-docs branch from 68573a9 to fd07947 Compare June 12, 2026 11:49
Comment thread README.md
Comment thread README.md
@marandaneto marandaneto force-pushed the docs/centralize-sdk-docs branch from 40ee1ab to 62d3a38 Compare June 12, 2026 12:14
@marandaneto

Copy link
Copy Markdown
Member Author

Addressed the README feedback in 40ee1ab: restored the badges and added the Laravel docs link.

@marandaneto marandaneto marked this pull request as ready for review June 12, 2026 12:19
@marandaneto marandaneto requested a review from a team as a code owner June 12, 2026 12:19
@marandaneto marandaneto enabled auto-merge (squash) June 12, 2026 12:19
@greptile-apps

greptile-apps Bot commented Jun 12, 2026

Copy link
Copy Markdown

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

@marandaneto marandaneto disabled auto-merge June 12, 2026 16:49
@marandaneto marandaneto merged commit cb15208 into main Jun 12, 2026
13 checks passed
@marandaneto marandaneto deleted the docs/centralize-sdk-docs branch June 12, 2026 16:50
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