Skip to content

docs: add buffa-build README - #684

Merged
iainmcgin merged 3 commits into
anthropics:mainfrom
fallintoplace:docs/buffa-build-readme
Oct 12, 2026
Merged

iainmcgin merged 3 commits into
anthropics:mainfrom
fallintoplace:docs/buffa-build-readme

Conversation

@fallintoplace

Copy link
Copy Markdown
Contributor

What

  • Add a README for buffa-build.

Why

  • The crate page had no quick setup or compiler requirements.

Implementation

  • Show the dependencies, a build.rs example, and the compiler choices.

@github-actions

github-actions Bot commented Oct 7, 2026

Copy link
Copy Markdown

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

A cargo add command stays right across releases, where the pinned
version strings would not. Remove the changelog fragment.
The protoc requirement and its minimum versions come before the example
that needs them, with a link to the guide's prerequisites section. Say
what use_buf needs, mark buffa-types as optional in the command block,
and write the project name in lowercase.
@iainmcgin

Copy link
Copy Markdown
Collaborator

[claude code] Thanks for writing a README for buffa-build, which had none on crates.io. I pushed two maintainer commits on top; the examples are unchanged. The first replaces the dependency snippet that pinned "0.9" three times with the cargo add commands from the user guide, so the page stays right after the next release, and removes the changelog fragment, because a README-only change does not get a changelog entry in this repository. The second moves the "Protobuf compiler" section above the quick start, since the example needs the compiler, and adds the minimum protoc versions from the user guide. It says what .use_buf() needs (a buf.yaml at the crate root; .includes() is ignored; .files() paths are relative to the buf module directory), points the compiler link at the prerequisites section of the guide, and marks buffa-types as optional in the command block.

@iainmcgin
iainmcgin enabled auto-merge October 12, 2026 20:06
@iainmcgin
iainmcgin added this pull request to the merge queue Oct 12, 2026
Merged via the queue into anthropics:main with commit ba45bcc Oct 12, 2026
11 checks passed
@github-actions github-actions Bot locked and limited conversation to collaborators Oct 12, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants