Repository navigation
[EPIC-D][LOU-D52] Revamp the README into a short, structured front page - #81
Merged
Merged
Conversation
README.md goes from 805 to 257 lines: a pitch with the three vetted differentiators, an honest install (not on npm yet) and quickstart, a one-line-per-feature list linking to docs, three type-checked examples (streamed tool use, approval + resume, durable sessions on SQLite), a documentation index, examples index, CLI table, deployment one-liner, and status/contributing/license. Everything the README dropped now lives in docs/: - new pages: tools, approvals, providers, cli, flows, guardrails, utilities - extended: api-overview (architecture diagram, store rows, links), configuration (full createAgent() options table; CLI moved to cli.md), installation and quick-start (not-on-npm notes), sub-agents (createDelegateTool example) - fixed: README anchor links in api-overview/sessions/streaming now point to approvals.md; workspace-tools no longer says createAgent() has no approval store; duplicate "## Stores" heading in sessions.md renamed. llms.txt / llms-full.txt regenerated. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_016bY29ibQgv3MDdjAbUT4YR
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
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.
What
README.md goes from 805 to 257 lines. It is now a front page with this order:
npm viewreturns 404). It shows how to scaffold from a checkout withnode bin/loushy.js init ../my-agent --sdk-path .(tested), then the 5-linecreateAgent({ model, instructions })quickstart.SqliteStore.Everything the old README had now lives in
docs/:tools.md,approvals.md,providers.md,cli.md,flows.md,guardrails.md(guardrails and sandboxed tools),utilities.md(encryption, storage, templates).api-overview.md: the architecture diagram, rows for the approval, checkpoint and SQLite stores,budget, and links to the new pages.configuration.md: the fullcreateAgent()options table. Its CLI section now points tocli.md.installation.mdandquick-start.md: a note that the package is not on npm yet, with the local-build route.sub-agents.md: thecreateDelegateTool()example.api-overview,sessions,streaming) now point toapprovals.md.workspace-tools.mdno longer sayscreateAgent()has no approval store (stale since LOU-D21).## Storesheading insessions.mdis renamed to## Choosing a store.llms.txtandllms-full.txtare regenerated. CHANGELOG gets a one-line Docs entry.No source code changed.
Why
The repo owner asked for this (LOU-D52): the README was too long and scattered. The new one follows the length and tone of the eve and open-harness READMEs, and no information is lost.
Acceptance criteria
docs/, and the README links to itapi-overview.mdstays the API index; the README links to it instead of duplicating ittsblock in the README and docs type-checks; the quick-start snippets still run against the packed tarballdocs/docs-links.test.ts, plus a local anchor check over the README and all docs pages: 0 bad)llms.txtandllms-full.txtregenerated and committedHow verified
npm run build: successnpm run build --workspace=packages/create-loushy-agent: successnpm run docs:verify-snippets -- --skip-build:all 95 snippet(s) type-check against src/; 6 also run cleanlynpm run docs:llms:check: exit 0npx vitest run docs examples scripts: 10 files, 73 tests passednpx tsc --noEmit: exit 0npm run lint: 0 errors, 433 warnings. This matches main, since no source changed.npm run test:types: no errorsnpx vitest run: 140 files passed, 2056 tests passed, 3 skipped. A first run before building the create-loushy-agent workspace had 4 failures in that package's tests; they pass after the build.npm run test:coverage && npm run fallow:✓ No issues found, exit 0🤖 Generated with Claude Code
https://claude.ai/code/session_016bY29ibQgv3MDdjAbUT4YR
Generated by Claude Code