ring-clojure / ring-clojure/ring
Document `:path-info` and `:context`
Open
Nobody has claimed this yet.
- Dominant language
- Clojure
- Stars
- 3.9k
- Forks
- 528
- PR merge metrics
- No merged PRs in 30d
Description
ring-core provides a set of tools to manipulate path-info and context keys
But those keys are not mentioned in ring spec, or nowhere else
I think that worth mentioning it in some document.
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 with ring-core/src/ring/util/request.clj at the referenced lines to review the path-info and context tools, then inspect the ring spec and existing documentation for the best placement. Document the :path-info and :context keys and their purpose, with the relevant links or examples, so users can find and understand them.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- clojure
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100