Skip to content

docs: add build.rs materialize how-to#591

Merged
EffortlessSteven merged 1 commit into
mainfrom
docs/howto-materialize-buildrs
May 12, 2026
Merged

docs: add build.rs materialize how-to#591
EffortlessSteven merged 1 commit into
mainfrom
docs/howto-materialize-buildrs

Conversation

@EffortlessSteven

Copy link
Copy Markdown
Member

Pure docs PR. Task-first how-to for materializing fixtures in build.rs. Part of the Phase 4 task-first user-paths sweep.

File added

  • docs/how-to/materialize-fixtures-in-build-rs.md — task-first walkthrough of the uselesskey-fixtures.toml manifest, the build.rs call sites (load_materialize_manifest, materialize_manifest_to_dir, emit_include_bytes_module), the OUT_DIR access pattern, and the two flavors (shape-only and runtime-rsa).

References

  • crates/materialize-shape-buildrs-example/ — shape-only manifest, build script, and consuming lib.rs used as the canonical shape-only template.
  • crates/materialize-buildrs-example/ — RSA-materialize manifest, build script, and consuming lib.rs used as the canonical runtime-rsa template.
  • Linked to docs/how-to/choose-features.md and examples/scanner-safe-bundle/README.md from the See Also section, and to docs/release/publish-recovery.md from the scanner-safety boundary section.

Test plan

  • cargo xtask docs-sync --check passes.
  • cargo xtask typos clean on the new file.
  • git diff --check reports no whitespace issues.
  • Doc references only existing files and code surfaces verified against the example crates.
  • Reviewer spot-checks the manifest field list against uselesskey_cli::MaterializeFixtureSpec and the build.rs excerpt against crates/materialize-buildrs-example/build.rs.

Phase 4 task-first how-to for the build.rs materialize workflow. Walks
through the uselesskey-fixtures.toml manifest, the build.rs call sites,
the OUT_DIR usage pattern, and the shape-only vs runtime-rsa flavors.
@gemini-code-assist

Copy link
Copy Markdown

Warning

You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again!

@coderabbitai

coderabbitai Bot commented May 12, 2026

Copy link
Copy Markdown

Warning

Rate limit exceeded

@EffortlessSteven has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 7 minutes and 9 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 30fd780a-89ed-4a79-ab72-330122a7342b

📥 Commits

Reviewing files that changed from the base of the PR and between e1f2f0a and 1ff9a8c.

📒 Files selected for processing (1)
  • docs/how-to/materialize-fixtures-in-build-rs.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/howto-materialize-buildrs

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 and usage tips.

@EffortlessSteven EffortlessSteven merged commit 3243bab into main May 12, 2026
5 checks passed
@EffortlessSteven EffortlessSteven mentioned this pull request May 12, 2026
4 tasks
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