Repository navigation
docs(bare): document bare_poll(), bare_attach(), and bare_detach() - #412
Merged
Merged
Conversation
Add the host-loop polling and attaching parts of the C embedding API to the Embedding section of the Bare runtime reference. They shipped in Bare 1.34.0 (holepunchto/bare#218 and #219) and are not documented anywhere on the site; the only prose was in the holepunchto/bare README, which is being trimmed to link here instead. The text is checked against include/bare.h, src/runtime.c, and the poll and attach tests at Bare 1.34.1. The version requirement is stated in prose, as on the embedder context page, because the bare-runtime doc-states axis only tracks the Bare global in npm/index.d.ts (1.32.0 is its newest) and a <Since> marker for 1.34.0 would fail check:docs-versions. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Preview deployments for pear-docs preview ⚡️
Commit: Deployment ID: Static site name: |
Preview deployments for pear-docs published ⚡️
Commit: Deployment ID: Static site name: |
lucas-tortora
added a commit
that referenced
this pull request
Oct 6, 2026
Conflicts in runtime.mdx are resolved in favour of published, whose #412 documents bare_poll(), bare_attach() and bare_detach() under Embedding. The C API reference and the Supported platforms section, which published does not have, are kept, with the reference now pointing at published's bare_poll() and bare_attach() sections. The release overview links to the new anchor. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
This was referenced Oct 6, 2026
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Document
bare_poll(),bare_attach(), andbare_detach()in the Embedding section of the Bare runtime reference.They shipped in Bare 1.34.0 (holepunchto/bare#218 and #219) and are not documented anywhere on the site. The only prose for them is in the
holepunchto/bareREADME, which is being trimmed in a separate PR to link to this page instead, so this should merge first.Notes
include/bare.h,src/runtime.c, and the poll and attach tests at Bare 1.34.1.bare-runtimedoc-states axis only tracks theBareglobal innpm/index.d.ts(newest 1.32.0), so a<Since v="1.34.0" />marker would failcheck:docs-versions.Testing
check-docs-versions,check-doctypes, andcheck-internal-linkspass.runtime.mdxcompiles with the repo's remark plugins.next buildor the dev server.🤖 Generated with Claude Code