You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+26-36
Original file line number
Diff line number
Diff line change
@@ -2,33 +2,33 @@
2
2
3
3
An assorted collection of tutorials, guides, and other documentation
4
4
(by various authors) for the Clojure programming language and its
5
-
ecosystem. [Read the guides online](https://clojure-doc.github.io).
5
+
ecosystem. [Read the guides online](https://clojure-doc.org).
6
6
7
-
> Note: due to loss of access to the original infrastructure hosting http://clojure-doc.org, this is a reboot of that site using [Cryogen](http://cryogenweb.org/) and hosted as a GitHub organization website. _Sean Corfield, November 14th, 2021._
7
+
> Note: due to loss of access to the original infrastructure hosting http://clojure-doc.org, this is a reboot of that site using [Cryogen](https://cryogenweb.org/) and hosted as a GitHub organization website. _Sean Corfield, November 14th, 2021._
8
8
9
9
> **Pull Requests should be made against the `source` branch, with changes to the Markdown files. The HTML on the `main` branch is auto-generated using Cryogen.**
10
10
11
+
> *News: funding for extensive work on CDS in 2023 is generally provided by [Clojurists Together](https://www.clojuriststogether.org/news/clojurists-together-2023-long-term-funding-announcement/) as part of their Long-Term Funding for [Sean Corfield](https://github.com/seancorfield).*
12
+
11
13
## Goals
12
14
13
15
The goal is to produce quality technical documentation with limited
14
-
duplication between guides, and eventually have these documents hosted
15
-
at doc.clojure.org.
16
-
16
+
duplication between guides.
17
17
18
18
What's *not* here:
19
19
20
20
* Cheatsheets. Those can be found at
21
-
[clojure.org/cheatsheet](https://clojure.org/api/cheatsheet), or with
22
-
tooltips at
23
-
[jafingerhut.github.com](http://jafingerhut.github.com). There is also an unofficial [ClojureScript cheatsheet](https://github.com/fogus/clojurescript-cheatsheet) available for download and contribution.
24
-
* API reference docs. Those can currently be found (with examples)
25
-
at [Clojuredocs](http://clojuredocs.org/).
21
+
[clojure.org/cheatsheet](https://clojure.org/api/cheatsheet), which is derived from
* API reference docs. The [official API docs](https://clojure.org/api/api)
26
+
also have a community-maintained version with examples
27
+
at [ClojureDocs](https://clojuredocs.org/).
26
28
27
29
CDS is not concerned with providing the API reference; only tutorials, guides, and
28
30
linking to other relevant resources.
29
31
30
-
31
-
32
32
## Structure
33
33
34
34
CDS is structured as a number of guides. They broadly fall into 4 categories:
@@ -41,7 +41,7 @@ CDS is structured as a number of guides. They broadly fall into 4 categories:
41
41
42
42
### Tutorials
43
43
44
-
These guides are for complete newcomers and should include a lot of hand holding. They don't assume any
44
+
These guides are intended for complete newcomers and should include a lot of hand holding. They don't assume any
45
45
previous familiarity with Clojure, the JVM, the JVM tool ecosystem, functional programming, immutability, and so on.
46
46
47
47
Target audience: newcomers to the language.
@@ -52,21 +52,21 @@ Target audience: newcomers to the language.
52
52
These guides are more in-depth, focused on various aspects of the language and interoperability.
53
53
Examples of such guides include:
54
54
55
-
* Sequences
55
+
* Collections & Sequences
56
+
* Concurrency & Parallelism
56
57
* Interoperability
57
-
* Reference types
58
58
* Laziness
59
-
* Macros and compilation
59
+
* Macros
60
60
61
61
Target audience: from developers who already have some familiarity with the language to those who have been using it for
62
62
a while.
63
63
64
64
65
65
### Tools & Ecosystem guides
66
66
67
-
These guides cover key Clojure ecosystem tools such as [Leiningen](http://leiningen.org), [Clojars](http://clojars.org), [REPLy](https://github.com/trptcolin/reply),
68
-
nREPL, Emacs clojure-mode, VimClojure, Counterclockwise, La Clojure, etc. It also covers important ecosystem projects that are not tools: books,
69
-
ClojureSphere, ClojureWerkz, Flatland and so on.
67
+
These guides cover key Clojure ecosystem tools such as [Leiningen](https://leiningen.org), [Clojars](https://clojars.org),
68
+
nREPL, Emacs, vim/neovim, Calva, etc. It also covers important ecosystem projects that are not tools: books,
69
+
communities, etc.
70
70
71
71
Target audience: all developers using or interested in the language.
72
72
@@ -77,19 +77,9 @@ Target audience: all developers using or interested in the language.
77
77
Concise Clojure example code, categorized by subject.
78
78
79
79
80
-
81
-
82
80
## How To Contribute
83
81
84
-
First of all: you **can** contribute to Clojure documentation even if you have 15 minutes to spare a day. To give you an example,
85
-
here's what 2 people could produce in about 6 months in their spare time:
Copy file name to clipboardExpand all lines: content/md/articles/about.md
+20-14
Original file line number
Diff line number
Diff line change
@@ -31,8 +31,14 @@ design goals, the ecosystem and operations is just as important. CDS will try to
31
31
32
32
What's *not* here:
33
33
34
-
* Cheatsheets. The official [Clojure cheatsheet](http://clojure.org/cheatsheet) is very good. There is also an unofficial [ClojureScript cheatsheet](https://github.com/fogus/clojurescript-cheatsheet) available for download and contribution.
35
-
* API reference docs. Those can currently be found (with examples) at [Clojuredocs](http://clojuredocs.org/).
34
+
* Cheatsheets. Those can be found at
35
+
[clojure.org/cheatsheet](https://clojure.org/api/cheatsheet), which is derived from
@@ -62,29 +68,29 @@ Target audience: newcomers to the language.
62
68
These guides are more in-depth, focused on various aspects of the language and interoperability.
63
69
Examples of such guides include:
64
70
65
-
* Sequences
71
+
* Collections & Sequences
72
+
* Concurrency & Parallelism
66
73
* Interoperability
67
-
* Reference types
68
74
* Laziness
69
-
* Macros and compilation
75
+
* Macros
70
76
71
77
Target audience: from developers who already have some familiarity with the language to those who have been using it for
72
78
a while.
73
79
74
80
75
81
### Tools & Ecosystem guides
76
82
77
-
These guides cover key Clojure ecosystem tools such as [Leiningen](http://leiningen.org), [Clojars](http://clojars.org), [REPLy](https://github.com/trptcolin/reply),
78
-
[nREPL](https://github.com/clojure/tools.nrepl), [Emacs clojure-mode](https://github.com/technomancy/clojure-mode), VimClojure, [Counterclockwise](https://code.google.com/p/counterclockwise/), [La Clojure](http://plugins.jetbrains.com/plugin?pluginId=4050), etc. It also covers important ecosystem projects that are not tools: books,
79
-
[ClojureSphere](http://www.clojuresphere.com/), [ClojureWerkz](http://clojurewerkz.org/), [Flatland](https://github.com/flatland) and so on.
83
+
These guides cover key Clojure ecosystem tools such as [Leiningen](https://leiningen.org), [Clojars](https://clojars.org),
84
+
[nREPL](https://nrepl.org), Emacs, vim, Calva, etc. It also covers important ecosystem projects that are not tools: books,
85
+
communities, etc.
80
86
81
87
Target audience: all developers using or interested in the Clojure programming language.
82
88
83
89
84
90
85
91
### Cookbooks
86
92
87
-
Concise [Clojure example code](content/#cookbooks), categorized by subject.
93
+
Concise [Clojure example code](/articles/content/#cookbooks), categorized by subject.
88
94
89
95
90
96
@@ -106,7 +112,7 @@ If you find a mistake, poor grammar, an important topic not covered, or an outda
106
112
107
113
## Contributing
108
114
109
-
CDS uses [Cryogen](http://cryogenweb.org/). All tutorials and guides are written in Markdown.
115
+
CDS uses [Cryogen](https://cryogenweb.org/). All tutorials and guides are written in Markdown.
110
116
111
117
The toolchain and setup process are described [in the README](https://github.com/clojure-doc/clojure-doc.github.io/blob/main/README.md#toolchain).
0 commit comments