clojure / clojure/clojure-site

Add RH answers page?

Open
#531 2 comments 0 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

Add a page similar to https://gist.github.com/reborg/dc8b0c96c397a56668905e2767fd697f to the guides. These are all quotes from Rich, so there is no problem here in migrating this content.

One thing I would like to do better is to contextualize these answers. In general, these are useful things to surface (we may need to do a bit of curation and review by Rich), but it's important for readers to understand that they are answers at a point in time. As such, they should clearly be quotes, and they should be visibly anchored to the time the answer was given, and whenever possible, a link or reference to the source, which often can provide further context. In some cases, there are useful follow-up links into the FAQ or other places on the site.

One open question is whether this should actually be integrated into https://clojure.org/guides/faq instead. My current thinking is no - while there is overlap, the framing and intent is different and they are both independently useful.

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 guides and the FAQ at clojure.org, then compare the proposed content with the linked gist. Define the page structure and curate the answers so each is clearly quoted, dated, and linked to its source where possible; done means the RH answers have a dedicated, contextualized page rather than being merged into the FAQ.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.