Trim README: move deep reference into docs/, keep it scannable#15
Merged
Conversation
README went 779 -> 454 lines. The long Configure/Providers/Ingest/Query/Semantic/ Writing-a-lens/Schema sections duplicated docs/, so they're compressed to short summaries + scannable tables (providers, fetchers, sources) + "see docs/X.md" pointers (exo-style). No detail lost: - new docs/schema.md (from the README schema section) - docs/writing-a-lens.md gains the string-shorthand form - docs/ingestion.md gains --yolo + the command allow_shell note All docs/ links resolve; full suite still 91 passing. Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
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 779 -> 454 lines (-42%). The long Configure / Providers / Ingest / Query / Semantic / Writing-a-lens / Schema sections duplicated
docs/(which are the fuller canonical versions), so they're compressed to short summaries + the scannable tables worth keeping (providers, fetchers, sources) +see docs/X.mdpointers -- the exo README pattern.No detail lost -- moved into docs first: new
docs/schema.md,docs/writing-a-lens.mdgains the string-shorthand form,docs/ingestion.mdgains--yolo+ thecommandallow_shellnote. All 8docs/links resolve; full suite 91 passing.🤖 Generated with Claude Code