Skip to content

docs: improve README clarity#52

Merged
rlippmann merged 16 commits into
mainfrom
final-cleanup
Jul 7, 2026
Merged

docs: improve README clarity#52
rlippmann merged 16 commits into
mainfrom
final-cleanup

Conversation

@rlippmann

Copy link
Copy Markdown
Owner

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

  • Enforcement point: multiple / repository documentation
  • Domain: repository maintenance
  • Technology/runtime: Python, TypeScript, package READMEs, example READMEs
  • Example type: repository maintenance
  • Does this use directive drafter? should normally be no: no
  • Does this derive state from model output? must be no for primary examples: no

Checklist

  • Repository scaffolding / governance change
  • One primary enforcement point
  • Explicit authoritative state
  • No model-derived state mutation
  • Adversarial stub or equivalent test
  • Observable runtime behavior change
  • Domain vocabulary is natural
  • Framework is secondary to the enforcement point
  • Docs updated
  • Tests/smoke checks added where practical

Notes

Docs-only cleanup.

Notable changes:

  • fixed stale and machine-local README links
  • clarified package README introductions for PyPI/npm readers
  • removed duplicate navigation and empty/dangling sections
  • consolidated the shared provider/model environment contract in PROVIDER_CONTRACT.md
  • removed cross-language navigation from language-specific docs
  • removed internal Tier 1 / Tier 2 / Tier 3 terminology from user-facing docs
  • made example introductions more behavior-first
  • documented the cross-language navigation policy in AGENTS.md

Markdownlint was run on changed Markdown files during the cleanup commits.

@rlippmann rlippmann merged commit 3842a2a into main Jul 7, 2026
6 checks passed
@rlippmann rlippmann deleted the final-cleanup branch July 7, 2026 07:34
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.

1 participant