luckyframework / luckyframework/website
Document websockets using Cable
Open
Nobody has claimed this yet.
- Dominant language
- Crystal
- Stars
- 39
- Forks
- 62
- PR merge metrics
- No merged PRs in 30d
Description
"websockets" is consistently one of the top search results in Algolia. Since we don't have built-in websocket stuff, lets just document setting up Cable for now.
Contributor guide
No contributing guide indexed for this repository
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
The issue names Cable as the subject but does not identify a documentation file or test. Start by locating the website's existing documentation structure and any current Cable setup guidance, then document how to set up Cable for websocket use. Done means the website explains the setup clearly enough for someone searching for websockets.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- crystal
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100