Skip to content

docs: improve navigation and package-facing documentation#51

Merged
rlippmann merged 8 commits into
mainfrom
docs-cleanup
Jul 6, 2026
Merged

docs: improve navigation and package-facing documentation#51
rlippmann merged 8 commits into
mainfrom
docs-cleanup

Conversation

@rlippmann

Copy link
Copy Markdown
Owner

Summary

Improve repository navigation, package-facing documentation, link consistency, and README clarity across the example integrations repository.

This PR is documentation-only. No example behavior, tests, or implementation code were changed.

Why

The repository now serves multiple audiences:

  • readers discovering Context Compiler through GitHub
  • readers discovering the examples package through PyPI
  • future readers discovering the TypeScript examples package through npm

Several documentation audits identified navigation friction, stale links, stale commands, duplicated navigation structures, and a few integration READMEs where operational detail appeared before the runtime behavior being demonstrated.

This PR improves discoverability and readability without changing any example behavior or technical claims.

Example metadata

  • Enforcement point: repository maintenance
  • Domain: documentation and discoverability
  • Technology/runtime: repository documentation
  • 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

Included:

  • language README navigation improvements
  • package-facing Python and TypeScript README updates
  • Python package README switch to python/README.md
  • repository link cleanup
  • stale command cleanup in the Ollama structured-output README
  • removal of duplicate navigation structures
  • clarification of example-discovery workflow
  • readability improvements in selected dense Python integration READMEs through section reordering and duplicate-content removal

Not included:

  • code changes
  • behavioral changes
  • test changes
  • enforcement-point additions
  • authority-model changes

@rlippmann
rlippmann merged commit 31b3bd3 into main Jul 6, 2026
6 checks passed
@rlippmann
rlippmann deleted the docs-cleanup branch July 6, 2026 22:15
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