Skip to content

Commit 51c6115

Browse files
readme: start to define the project purpose and goals
1 parent 7a079b0 commit 51c6115

1 file changed

Lines changed: 30 additions & 0 deletions

File tree

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Alternative Clojure.org
2+
3+
The purpose of this website is to experiment with content, design and UX ideas for enhancing and extending the Clojure.org website.
4+
5+
This project is not currently sponsored by Nubank or with any collaboration from the Clojure core team (although both would be welcome).
6+
7+
A secondary purpose is to evaluate the capabilities of [Zensical](https://zensical.org/). This a fast static site generator with a rich author experience to create highly engaging websites.
8+
9+
> NOTE: Zensical is under very active development and already provides a good experience. Adoption is growing and feature parity with [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) is expected by Autumn 2026.
10+
11+
## Values
12+
13+
- highly discoverable information
14+
- opinionated guides that cover the most important information
15+
- REPL centric content
16+
17+
18+
## Goals
19+
20+
- Minimal time to REPL
21+
- Focus on core libraries and tools
22+
- Practical content to simplify adoption
23+
24+
25+
## Sections
26+
27+
- Definitive guide to Clojure CLI
28+
- First Steps into the Language (syntax & concepts)
29+
- Evaluating Clojure (editor agnostic)
30+
- Managing REPL State

0 commit comments

Comments
 (0)