playframework / playframework/playframework
play-socket.io not mentioned in documentation and examples
Open
Nobody has claimed this yet.
help wanted
topic:documentation
- Dominant language
- Scala
- Stars
- 12.6k
- Forks
- 4k
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 29
Description
Play Version (2.5.x / etc)
2.6.x
API (Scala / Java / Neither / Both)
both
Actual Behavior
The clustered chat client for socket io is not mentioned in the main play documentation and the chatroom examples don't mention it either:
- https://github.com/playframework/play-socket.io/tree/master/samples/scala/clustered-chat
- https://github.com/playframework/play-socket.io/tree/master/samples/java/clustered-chat
not mentioned in
etc
May also want to add to tutorials page:
and include links to socket.io from the home page / 2.6.x highlights etc:
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the play-socket.io clustered-chat samples, the play-scala-chatroom-example, the Play 2.6 Tutorials WebSocket page, and the linked blog post. Identify the appropriate documentation, example, home-page, and highlights locations, then add references to play-socket.io and verify that all intended links render correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, scala
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100