clojure / clojure/clojure-site

Update "libs" reference page to reflect modern use of term

Open
#530 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

blocked needs input
Dominant language
HTML
Stars
259
Forks
275
PR merge metrics
No merged PRs in 30d

Description

The https://clojure.org/reference/libs page is an old page and has a lot of useful information on it, but uses "lib" as a term to mean a Clojure namespace, which matches many 1.0-era docstrings. However, in modern use, "lib" is more commonly used to refer to a whole library, made up of many Clojure namespaces. This disconnect is confusing and/or jarring depending on your experience level with Clojure.

Should we update this page to clarify, merge with the https://clojure.org/reference/namespaces page, or something else?

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

Read the current https://clojure.org/reference/libs and https://clojure.org/reference/namespaces pages first, then compare how each uses “lib” and “namespace.” Done means the relationship and modern terminology are clarified without leaving confusing or duplicated guidance; the issue does not choose between updating or merging, so that decision needs maintainer input.

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
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.