Skip to content

docs: centralize SDK examples in official docs#171

Merged
marandaneto merged 1 commit into
mainfrom
docs/centralize-sdk-docs
Jun 12, 2026
Merged

docs: centralize SDK examples in official docs#171
marandaneto merged 1 commit into
mainfrom
docs/centralize-sdk-docs

Conversation

@marandaneto

Copy link
Copy Markdown
Member

💡 Motivation and Context

SDK README, usage, and example markdown files duplicated code snippets that can drift from the official documentation. This keeps usage examples in the official docs as the single source of truth and leaves repository markdown as lightweight navigation.

💚 How did you test it?

  • Ran git diff --check.
  • Verified remaining README/USAGE/example-style markdown files no longer contain fenced code snippets.
  • Verified stale USAGE.md/old integration-doc links were removed or updated.

📝 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
Contributor

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

@marandaneto marandaneto marked this pull request as ready for review June 12, 2026 12:29
@marandaneto marandaneto requested a review from a team as a code owner June 12, 2026 12:29
@marandaneto marandaneto enabled auto-merge (squash) June 12, 2026 12:29
@marandaneto marandaneto merged commit 0ab6692 into main Jun 12, 2026
19 checks passed
@marandaneto marandaneto deleted the docs/centralize-sdk-docs branch June 12, 2026 16:06
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