ring-clojure / ring-clojure/ring

Support cljdoc

Open
#518 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Clojure
Stars
3.9k
Forks
528
PR merge metrics
No merged PRs in 30d

Description

Hey there,

I was just looking at the ring docs on cljdoc and noticed that it doesn't pick up all the great docs in the wiki.

Would you be interested in contributions to either

  1. moving your wiki content into the repo or
  2. finding another way that maybe 'syncs' the docs to the repo?

Best,
Martin

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the cljdoc page linked in the issue and comparing it with the Ring wiki content. Determine whether the documentation should move into the repository or be synchronized another way; done means the wiki documentation is available through cljdoc.

Written by the indexing model from the issue text.

Assessment

Tech stack
clojure
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.