Skip to content

docs(examples/audiobook-curator): launcher opener, mcp run section, canonical check chain - #64

Merged
ScriptedAlchemy merged 2 commits into
mainfrom
chore/audiobook-polish
Aug 31, 2026
Merged

docs(examples/audiobook-curator): launcher opener, mcp run section, canonical check chain#64
ScriptedAlchemy merged 2 commits into
mainfrom
chore/audiobook-polish

Conversation

@ScriptedAlchemy

Copy link
Copy Markdown
Owner

Summary

Wave A1 of the examples refresh audit — scoped to examples/audiobook-curator/{README.md,package.json} only.

  • README: adds the shared "From the repository root… pnpm example:audiobook" opener the other product examples carry (the root package.json and README already advertise the script; this README never mentioned it).
  • README: adds a Run the MCP server section for the curator server, mirroring the canonical mcp run doc flow in examples/mcp-app/README.md — this is the only example that ships an MCP server and didn't document it. Uses --target claude (this example builds claude/codex, no portable) and --artifact artifact (this example's build output lands under artifact/, not dist/).
  • README: prunes the maintainer-notes refactor-archaeology sentence naming deleted files (rslib.config.ts, tsconfig.build.json, the bin shim, src/cli-entry.ts, build:cli/build:bundle), keeping the forward-looking docs/entry-conventions.md link.
  • package.json: aligns check to the canonical validate && build && typecheck && test chain (matching the create-agent-bundle templates); --output artifact on build is kept — it's required here, not redundant (AB4706).

Deliberately untouched: the <AgentBundle> JSX-tree description in the source-layout section (rewritten by the in-flight RFC #63 framework-mode arc) and the --json build flags (Wave A4 cross-example sweep).

Test plan

  • pnpm --filter @agent-bundle-example/audiobook-curator check — validate, build, typecheck, test all green
  • packages/agent-bundle/tests/examples-contract.test.ts — passes
  • Root pnpm typecheck + pnpm lint — clean

…section, and canonical check chain

The only example shipping an MCP server never documented `mcp run`, never
mentioned its root `pnpm example:audiobook` launcher, and narrated deleted
files in its maintainer notes. Adds the shared repo-root opener the other
product examples carry, mirrors the canonical `mcp run` doc flow from
examples/mcp-app for the `curator` server, prunes the refactor-archaeology
sentence (keeping the entry-conventions link), and aligns `check` to the
canonical `validate && build && typecheck && test` chain.
@changeset-bot

changeset-bot Bot commented Aug 31, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 0a42af4

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Aug 31, 2026

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review Completed 2026-08-31T06:25:51.833166Z d3ecd04 PR opened
ℹ️ 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" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@pkg-pr-new

pkg-pr-new Bot commented Aug 31, 2026

Copy link
Copy Markdown
npm i https://pkg.pr.new/ScriptedAlchemy/agent-bundle@64
npm i https://pkg.pr.new/ScriptedAlchemy/agent-bundle/create-agent-bundle@64
npm i https://pkg.pr.new/ScriptedAlchemy/agent-bundle/@agent-bundle/rsc-runtime@64

commit: 0a42af4

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: d3ecd04718

ℹ️ 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".

Comment thread examples/audiobook-curator/README.md
@ScriptedAlchemy
ScriptedAlchemy merged commit 5179dc9 into main Aug 31, 2026
9 checks passed
@ScriptedAlchemy
ScriptedAlchemy deleted the chore/audiobook-polish branch September 3, 2026 05:23
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