Skip to content

Correct and expand the WebSockets documentation#79

Merged
Vectornaut merged 1 commit intomainfrom
websocket-docs-correction
Apr 14, 2026
Merged

Correct and expand the WebSockets documentation#79
Vectornaut merged 1 commit intomainfrom
websocket-docs-correction

Conversation

@Vectornaut
Copy link
Copy Markdown
Collaborator

Summary

The branch to be merged corrects some errors that prevented the WebSockets sample code from compiling.

Changes

Corrections

The errors corrected include the ones described in issue #77, which affect the code in the "Writing a WebSocket controller" section.

They also include an additional error in the "Starting a WebSocket server" section; the code from this section is needed to build a runnable program.

Expansion

The branch to be merged also expands the testing instructions to confirm that the echo server is working as intended.

Validation

I've checked my changes using the following process.

  1. Start a new crate with the following Cargo.toml.

    [package]
    name = "websocket-docs-test"
    version = "0.1.0"
    edition = "2024"
    
    [dependencies]
    rwf = "0.2.1"
  2. Copy the code from the corrected documentation sections into src/main.rs.

  3. Start the server with cargo run and then follow the expanded testing instructions from the documentation.

@Vectornaut Vectornaut marked this pull request as draft April 14, 2026 06:50
@Vectornaut
Copy link
Copy Markdown
Collaborator Author

Thanks for the review, @levkk! I've marked this as a draft while waiting for pull request #81 to be merged. Once that happens, this branch should be able to pass its continuous integration checks (maybe after rebasing onto #81), and I'll open it again.

@Vectornaut Vectornaut marked this pull request as ready for review April 14, 2026 07:01
Correct some errors that prevented the WebSockets sample code from
compiling. Expand the testing instructions to confirm that the echo
server is working as intended.
@Vectornaut Vectornaut force-pushed the websocket-docs-correction branch from 7b03707 to b1061d0 Compare April 14, 2026 07:04
@Vectornaut
Copy link
Copy Markdown
Collaborator Author

Rebased onto #81; continuous integration checks now pass! Merging.

@Vectornaut Vectornaut merged commit 4e84b6d into main Apr 14, 2026
3 checks passed
@Vectornaut Vectornaut deleted the websocket-docs-correction branch April 14, 2026 07:10
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.

2 participants