Skip to content

docs: align guidance and package contracts - #152

Merged
proggeramlug merged 1 commit into
codex/rendering-wip-integrated-20260727from
codex/docs-audit-fixes
Aug 30, 2026
Merged

docs: align guidance and package contracts#152
proggeramlug merged 1 commit into
codex/rendering-wip-integrated-20260727from
codex/docs-audit-fixes

Conversation

@proggeramlug

Copy link
Copy Markdown
Contributor

Summary

  • correct README and reference documentation for the active 0.5 API, supported targets, and module layout
  • make the published package self-contained for path crates, Jolt fallback sources, and the bloom-web CLI
  • add documentation validation and wire it into the CI contract checks

Verification

  • node tools/check-ci-contract.js
  • node tools/validate-docs.js
  • npm package consumer smoke test, including Cargo metadata and bloom-web --help
  • git diff --check

@coderabbitai

coderabbitai Bot commented Aug 30, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 3ad6ad84-cadd-4607-aaae-8e3fd88f2709

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

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.

@proggeramlug
proggeramlug merged commit ed298fb into codex/rendering-wip-integrated-20260727 Aug 30, 2026
1 check passed
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