Skip to content

docs: declutter README and add monorepo architecture - #36

Merged
zz-plant merged 1 commit into
mainfrom
docs/declutter-readme
Oct 12, 2026
Merged

zz-plant merged 1 commit into
mainfrom
docs/declutter-readme

Conversation

@zz-plant

Copy link
Copy Markdown
Collaborator

Declutters the root README (469 -> 182 lines). Adds monorepo architecture tree, developer build/test loop, and streamlined documentation links while preserving ground-truth corpus benchmarks and license obligations.

@zz-plant
zz-plant merged commit 2699537 into main Oct 12, 2026
3 checks passed
@zz-plant
zz-plant deleted the docs/declutter-readme branch October 12, 2026 16:37
zz-plant added a commit that referenced this pull request Oct 13, 2026
README.md conflicted: this branch and main's "docs: declutter README" (#36)
each rewrote it from the same 469-line version. Kept this branch's README,
which documents `refract review`, the offline walkthrough and the captured
Bitcoin example, and carried over what #36 added that it lacked: the Bun
badge, the Python SDK (as a row in "Use it in your application"), the
monorepo architecture tree, and the development commands, using
`bun run test` (vitest) rather than `bun test`. #36's Semaglutide sample
output and its docs link list are not carried over; every link in that list
except the docs/README.md hub already appears in this README.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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