clojure / clojure/clojure-site
Socket REPL guide
Open
Nobody has claimed this yet.
content
- Dominant language
- HTML
- Stars
- 259
- Forks
- 275
- PR merge metrics
- No merged PRs in 30d
Description
It could be good to expand docs on the socket REPL to:
- Explain motivations for creating the socket REPL
- Explain how it can be used or extended
- Explain how it is different from the current Clojure REPL, and nREPL
- Discuss the streaming nature of the REPL
There is some good information in the design doc that could be collated for this.
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 locating the socket REPL documentation and the referenced design document. Review the existing explanations of the current Clojure REPL and nREPL, then document the socket REPL's motivation, extension and usage, differences, and streaming behavior. Done means these topics are clearly covered and the design document's useful information is collated.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- clojure
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100