DioxusLabs / DioxusLabs/docsite
Wrong naming case, must use "WebSocket" not "Websocket"
- Dominant language
- Rust
- Stars
- 206
- Forks
- 208
- Avg merge
- 1h 11m
- Merged PRs (30d)
- 3
Description
Hello, I was reading about implementing web-socket into my code, the documentation and the code confuse between `WebSocket` and `Websocket`.
In title it's ` WebsocketOptions` in code it is `WebSocketOptions`,
and `Websocket` as type for result not `WebSocket` like `WebSocketOptions`.
https://github.com/DioxusLabs/docsite/blob/22a93ecf49e68754d8c821eb55443fb04746246b/docs-src/0.7/src/essentials/fullstack/websockets.md?plain=1#L13-L19
Strandard name is `WebSocket` https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API
Contributor guide
No contributing guide indexed for this repository
Research direction
Open docs-src/0.7/src/essentials/fullstack/websockets.md and inspect the references around lines 13-19. Check the title and code examples for inconsistent Websocket casing, then confirm that the terminology consistently uses WebSocket, including WebSocketOptions and the result type.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 85/100