Merged
Conversation
Contributor
Reviewer's GuideThis update refines the roadmap documentation by standardizing connection feature bullets with consistent imperative verbs and grammar, and expands the testing utilities section by adding a concrete example reference. Flow Diagram of Additions to Project Roadmapgraph TD
RoadmapAdditions["Additions to Roadmap Document"]
RoadmapAdditions --> ConnectionFeatures["Connection Features Section"]
ConnectionFeatures --> Item1["New: Add connection preamble support"]
ConnectionFeatures --> Item2["New: Add response serialization and transmission"]
ConnectionFeatures --> Item3["New: Add connection lifecycle hooks"]
RoadmapAdditions --> TestingUtilities["Testing Utilities Section"]
TestingUtilities --> Item4["New: Provide testing utilities for handlers"]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
WalkthroughThe roadmap documentation was updated to outline new core library foundation tasks, including connection preamble support, response serialization and transmission, and connection lifecycle hooks. Additionally, a new developer tooling item was added to provide testing utilities for handlers, with references to early examples and future plans for a dedicated crate. Changes
Possibly related PRs
Suggested reviewers
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![codescene-delta-analysis[bot]](https://avatars.githubusercontent.com/in/53921?s=60&v=4){kind=small}
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/roadmap.md (2)
58-66: Ensure proper list nesting in MarkdownThe descriptive lines under each “Add …” bullet are indented but lack hyphens, which can break list nesting in many Markdown renderers. Consider converting them into true sub-bullets and aligning indentation consistently. For example:
- [ ] Add connection preamble support. - Provide built-in parsing of a handshake preamble (e.g., Hotline's "TRTP") - and invoke a user-configured handler on success or failure. + [ ] Add connection preamble support. + - Provide built-in parsing of a handshake preamble (e.g., Hotline's "TRTP") and invoke a user-configured handler on success or failure.Or split into two sub-items:
+ - Provide built-in parsing of a handshake preamble (e.g., Hotline's "TRTP"). + - Invoke a user-configured handler on success or failure.
107-111: Convert detail lines into Markdown sub-bulletsSimilarly, the notes under “Provide testing utilities for handlers.” should be proper nested list items. For example:
- [ ] Provide testing utilities for handlers. - Offer simple ways to drive handlers with raw frames for unit tests. - Early examples live in [`tests/server.rs`](../tests/server.rs); future - helpers may reside in a `wireframe-testing` crate. + [ ] Provide testing utilities for handlers. + - Offer simple ways to drive handlers with raw frames for unit tests. + - Early examples live in [`tests/server.rs`](../tests/server.rs); future helpers may reside in a `wireframe-testing` crate.
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
This was referenced Jun 14, 2025
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
Testing
cargo fmt -- --checkcargo clippy -- -D warningsRUSTFLAGS="-D warnings" cargo testnpx --yes markdownlint-cli2 '**/*.md'nixie docs/roadmap.mdhttps://chatgpt.com/codex/tasks/task_e_684cc2469088832284a02668c1669efd
Summary by Sourcery
Revise the roadmap documentation to improve consistency and clarity
Documentation:
Summary by CodeRabbit