fix: update compio docs#16
Merged
Merged
Conversation
|
Preview Deployed! Your changes have been deployed to a preview environment. You can view it here: https://3a08b7e9-compio-website.popx.workers.dev |
George-Miao
requested changes
Feb 19, 2026
There was a problem hiding this comment.
Pull request overview
Updates Compio documentation/navigation to reflect new and clarified modules (notably WebSocket), plus several driver/networking doc refinements.
Changes:
- Add a new WebSocket documentation page and link it in the docs summary.
- Update networking/socket docs (options wording, UDP ancillary/control message notes) and mention
compio-ws. - Refine driver docs (polling/io-uring behavior notes, shared FD ownership model) and expand a dispatcher note.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| content/docs/summary.ts | Adds WebSocket entry to the Compio docs sidebar. |
| content/docs/compio/ws.md | Introduces a new WebSocket documentation page. |
| content/docs/compio/net/sockets.md | Renames/expands socket options section and replaces a TODO with UDP ancillary data guidance. |
| content/docs/compio/net.md | Mentions WebSocket support crate (compio-ws) alongside TLS/QUIC. |
| content/docs/compio/io.md | Tweaks managed buffer pool wording and adds a placeholder “Framed IO” section. |
| content/docs/compio/driver/polling.md | Adds note about selecting the driver via ProactorBuilder and adjusts subheadings. |
| content/docs/compio/driver/io-uring.md | Updates kernel/feature fallback behavior description. |
| content/docs/compio/driver.md | Updates shared FD ownership description (Rc/Arc depending on sync). |
| content/docs/compio/dispatcher.md | Adds a short note about alternative approaches to multithreading servers. |
| content/docs/compio/buffers.md | Updates IoBufMut description and adds IoBufMut::uninit mention. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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
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.
No description provided.