micropython / micropython/micropython
docs: document uwebsocket module
Open
Nobody has claimed this yet.
docs
- Dominant language
- C
- Stars
- 22.1k
- Forks
- 9k
- Avg merge
- 6d 4h
- Merged PRs (30d)
- 16
Description
It needs basic docs to explain that it's mainly used for webrepl and does not have a full websocket implementation.
See related: #2410, #4450.
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
Start by reviewing the existing uwebsocket and webrepl references, along with related issues #2410 and #4450. Document that uwebsocket is mainly used by webrepl and is not a full websocket implementation; done means these basics are covered in the appropriate documentation location.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100