clojure / clojure/clojure-site

Add FAQ or guide for example projects

Open
#586 6 comments 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

content help wanted
Dominant language
HTML
Stars
259
Forks
275
PR merge metrics
No merged PRs in 30d

Description

One of the most common requests we see from Clojure learners is for example real code bases to look at that demonstrate good style and usage. There are many good answers to this question (you can search Slack or other sources to find places people have answered this, often repeatedly). I would like to have a well-known place that we can point people to when they ask this question (and/or point them to it proactively in our getting started path).

This could just be a https://clojure.org/guides/faq entry with a guided list of suggestions or a whole new guide that provided more context.

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 existing https://clojure.org/guides/faq and the getting started path, then search Slack and other sources for repeated recommendations of real Clojure code bases. Done means a well-known FAQ entry or guide provides a curated, contextual list that can be shared with learners and possibly linked proactively from getting started.

Written by the indexing model from the issue text.

Assessment

Tech stack
clojure
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.