docs: improve README clarity#52
Merged
Merged
Conversation
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Improve README clarity, navigation, and package-facing documentation across the example integrations repo.
This PR keeps the examples behaviorally unchanged while making the docs easier to use from GitHub, PyPI, and npm package pages.
Why
The README set had accumulated stale links, duplicate navigation, internal terminology, and architecture-first wording. This made the examples harder to scan and increased drift risk around shared provider/runtime documentation.
The cleanup makes the docs more behavior-first: readers should be able to see what changes at runtime, where authoritative state is enforced, and which example to open next.
Example metadata
Checklist
Notes
Docs-only cleanup.
Notable changes:
PROVIDER_CONTRACT.mdAGENTS.mdMarkdownlint was run on changed Markdown files during the cleanup commits.