docs: trim README to a trailhead (front door, not the encyclopedia)#16
Merged
Conversation
The README duplicated the docs (full quickstart, every connector, every backend, the whole API) — a 375-line drift surface whose examples, unlike the docs', weren't tested. README = trailhead (the GitHub + PyPI front door); docs = destination (the comprehensive, CI-verified source of truth). - README → 95 lines: pitch, the one self-building-graph "aha", install, the MCP one-liner, and a Documentation signpost (absolute URLs so they resolve on PyPI too). Encyclopedic content now lives only in the docs. - Extend the example-doctest to also run the README's snippet, so the front door can't drift either. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
1 participant
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.
README = trailhead (GitHub + PyPI front door); docs = destination (comprehensive, CI-verified source of truth).
The README had grown to 375 lines duplicating the docs (quickstart, every connector/backend, full API) — a drift surface whose examples weren't tested.
Verified: 8 passed / 11 skipped, ruff clean.
🤖 Generated with Claude Code