Skip to content

Automate BAML book review bundles - #4671

Draft
hellovai wants to merge 1 commit into
codex/docs-preview-versions-starsfrom
codex/docs-book-review-bundle
Draft

Automate BAML book review bundles#4671
hellovai wants to merge 1 commit into
codex/docs-preview-versions-starsfrom
codex/docs-book-review-bundle

Conversation

@hellovai

@hellovai hellovai commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Outcome

Editors can now turn the pinned baml-book revision into a deterministic review bundle without publishing any prose or checking generated pages into the repository.

The bundle:

  • discovers chapters in src/SUMMARY.md order;
  • refuses dirty or incorrectly-versioned source checkouts;
  • expands and validates includes, listings, runnable projects, and quizzes;
  • emits converted MDX previews plus exact source and output SHA-256 hashes;
  • provides manifest snippets that are explicitly labeled for use only after human approval.

End-user impact

Before, preparing a book chapter for /baml/book required manually finding the source, deriving its route and hash, and testing its conversion. Now an editor can run:

pnpm --filter @baml/developer-docs review:book -- \
  --source /path/to/clean/baml-book \
  --output /tmp/baml-book-review

No chapter becomes public until its reviewed entry is deliberately copied into docs/book-import.json.

Verification

  • 38 docs tests pass.
  • Docs typecheck passes against two local immutable toolchain metadata artifacts.
  • The real pinned baml-book commit produced four candidates and validated the runnable Getting Started listing and quiz.

@vercel

vercel Bot commented Sep 1, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
beps Ready Ready Preview Sep 1, 2026 7:44am UTC
developer-docs Ready Ready Preview Sep 1, 2026 7:44am UTC
promptfiddle2 Ready Ready Preview Sep 1, 2026 7:44am UTC

Request Review

@coderabbitai

coderabbitai Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

  • Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

github-actions Bot commented Sep 1, 2026

Copy link
Copy Markdown

⏭️ Performance benchmarks were skipped

Perf benchmarks (CodSpeed) are opt-in on pull requests — they no longer run on every push. They always run automatically after merge to canary/main.

To run them on this PR, do any of the following, then push a commit (or re-run CI):

  • Add RUN_CODSPEED=1 to the PR description, or
  • Include run-perf or /perf in the PR title or any commit message.

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