Skip to content

Commit 490e23d

Browse files
alexander-yakushevbbatsov
authored andcommitted
Cleanup the docs
1 parent b887c7f commit 490e23d

File tree

5 files changed

+27
-71
lines changed

5 files changed

+27
-71
lines changed

doc/modules/ROOT/pages/about/history.adoc

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,15 @@ with the assumption that this would make it easier to develop CIDER and would op
77
to build complex features like an interactive debugger. Fortunately, the assumption turned out to be correct.
88
Today `cider-nrepl` provides pretty much everything that a Clojure development environment might need (and more).
99

10-
We quickly
11-
realized that there was nothing CIDER specific in those middleware and we've
12-
started to encourage more tool authors to leverage them. Today `cider-nrepl` is
13-
developed and released independently from CIDER and is used by most of the
14-
nREPL-based editors and IDEs out there, which is a great example of team work.
15-
Eventually `cider-nrepl` served as the inspiration for more similar
10+
We quickly realized that there was nothing CIDER specific in those middleware
11+
and we've started to encourage more tool authors to leverage them. Today
12+
`cider-nrepl` is developed and released independently from CIDER and is used by
13+
most of the nREPL-based editors and IDEs out there, which is a great example of
14+
team work. Eventually `cider-nrepl` served as the inspiration for more similar
1615
middleware libraries - e.g. `refactor-nrepl`, `iced-nrepl` and `sayid`.
1716

18-
More recently we've been working to extract the core functionality out of `cider-nrepl`
19-
into a https://github.com/clojure-emacs/orchard[REPL-agnostic library].footnote:[This process started in 2019.]
17+
In 2019, the core functionality has been extracted out of `cider-nrepl` into
18+
https://github.com/clojure-emacs/orchard[Orchard], a REPL-agnostic library.
2019

2120
You can check out https://www.youtube.com/watch?v=4X-1fJm25Ww[this talk], which explores the birth of
2221
`cider-nrepl`.

doc/modules/ROOT/pages/compatibility.adoc

Lines changed: 6 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,15 @@ Currently `cider-nrepl` requires Piggieback 0.4+ to work properly.
3131

3232
`cider-nrepl` supports nREPL 0.6+.
3333

34-
NOTE: We pay special attention to supporting whatever nREPL is bundled with the current stable Leiningen
35-
and Boot releases.
34+
NOTE: We pay special attention to supporting whatever nREPL is bundled with the
35+
current stable Leiningen release.
3636

3737
== Compatibility Matrix
3838

39-
Below you can find the official compatibility matrix for `cider-nrepl`. For a
40-
very long time the project targeted nREPL 0.2.x, but the
41-
requirements were bumped to nREPL 0.6 in recent versions.
39+
Below you can find the official compatibility matrix for `cider-nrepl`.
40+
41+
NOTE: The matrix lists only the last versions of `cider-nrepl` that supports the
42+
given compatibility tuple.
4243

4344
.Compatibility Matrix
4445
|===
@@ -54,26 +55,6 @@ requirements were bumped to nREPL 0.6 in recent versions.
5455
| 1.8
5556
| 0.4.x
5657

57-
| 0.21
58-
| 8
59-
| 1.8
60-
| 0.6
61-
62-
| 0.22
63-
| 8
64-
| 1.8
65-
| 0.6
66-
67-
| 0.23
68-
| 8
69-
| 1.8
70-
| 0.6
71-
72-
| 0.24
73-
| 8
74-
| 1.8
75-
| 0.6
76-
7758
| 0.25
7859
| 8
7960
| 1.8

doc/modules/ROOT/pages/index.adoc

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,14 +73,20 @@ hackers to make this a reality.
7373

7474
=== Isolated Runtime Dependencies
7575

76-
All of cider-nrepl's dependencies are processed with
76+
Most of cider-nrepl's dependencies are processed with
7777
https://github.com/benedekfazekas/mranderson[mranderson], so that
7878
they won't collide with the dependencies of your own projects. This
79-
basically means that cider-nrepl doesn't have any runtime dependencies in
79+
basically means that cider-nrepl has almost no runtime dependencies in
8080
the production artifact - just copies of the deps inlined with changed
8181
namespaces/packages. It's a bit ugly and painful, but it gets the job
8282
done.
8383

84+
The exclusion to this rule are the artifacts that are themselves part of the
85+
CIDER ecosystem and have to runtime dependencies of their own:
86+
87+
- https://github.com/clojure-emacs/orchard[Orchard]
88+
- https://github.com/clojure-emacs/logjam[Logjam]
89+
8490
If someone has better ideas how to isolate our runtime dependencies -
8591
we're all ears!
8692

doc/modules/ROOT/pages/internals.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
== Lazy middleware loading
44

5-
Eager loading of all of `cider-nrepl`'s middleware resulted in a significant impact to the
5+
Eager loading of all of cider-nrepl's middleware resulted in a significant impact to the
66
startup time of the nREPL server. To mitigate this we've devised a strategy to postpone
77
the actual initialization of some middleware until the first time it's actually used
88
by a client.
@@ -42,16 +42,16 @@ a string). Hopefully this will change down the road.
4242

4343
== Dependency obfuscation
4444

45-
`cider-nrepl`'s dependency would conflict with the dependencies of the application using it,
45+
cider-nrepl's dependency would conflict with the dependencies of the application using it,
4646
so we have to take some care to avoid such situation.
4747

48-
All of cider-nrepl's dependencies are processed with
48+
Most of cider-nrepl's dependencies are processed with
4949
https://github.com/benedekfazekas/mranderson[mranderson], so that
5050
they won't collide with the dependencies of your own projects. This
5151
basically means that cider-nrepl doesn't have any runtime dependencies in
5252
the production artifact - just copies of the deps inlined with changed
5353
namespaces/packages.
5454

5555
This means that `cider-nrepl` has to also take some steps to hide the inlined namespaces,
56-
so they won't pollute the results users would be interested in. Pretty much all of `cider-nrepl`'s
56+
so they won't pollute the results users would be interested in. Pretty much all of cider-nrepl's
5757
ops would filter out the inlined namespaces.

doc/modules/ROOT/pages/usage.adoc

Lines changed: 2 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -58,36 +58,6 @@ under `:repl-options`.
5858
cider.nrepl/wrap-xref]}
5959
----
6060

61-
=== Via Boot
62-
63-
Boot users can configure the injected middleware by either specifying
64-
it on the command line through the `cider.tasks/add-middleware` task
65-
(the lengthy command below will include the `apropos` and `version`
66-
functionality):
67-
68-
----
69-
boot -d nrepl:1.0.0 -d cider/cider-nrepl:0.49.0 -i "(require 'cider.tasks)" cider.tasks/add-middleware -m cider.nrepl.middleware.apropos/wrap-apropos -m cider.nrepl.middleware.version/wrap-version repl --server wait
70-
----
71-
72-
Or for all of their projects by adding a `~/.boot/profile.boot` file like so:
73-
74-
[source,clojure]
75-
----
76-
(set-env! :dependencies '[[nrepl "1.0.0"]
77-
[cider/cider-nrepl "0.49.0"]])
78-
79-
(require '[cider.tasks :refer [add-middleware]])
80-
81-
(task-options! add-middleware {:middleware '[cider.nrepl.middleware.apropos/wrap-apropos
82-
cider.nrepl.middleware.version/wrap-version]})
83-
----
84-
85-
And then launching `boot add-middleware repl --server wait`.
86-
87-
Note that this is not necessary when using the standard `cider-jack-in`.
88-
89-
For more information visit https://github.com/boot-clj/boot/wiki/Cider-REPL[boot-clj wiki].
90-
9161
== Via clj
9262

9363
You can easily boot an nREPL server with the CIDER middleware loaded
@@ -103,11 +73,11 @@ There are also two convenient aliases you can employ:
10373
----
10474
{...
10575
:aliases
106-
{:cider-clj {:extra-deps {org.clojure/clojure {:mvn/version "1.10.1"}
76+
{:cider-clj {:extra-deps {org.clojure/clojure {:mvn/version "1.10.3"}
10777
cider/cider-nrepl {:mvn/version "0.49.0"}}
10878
:main-opts ["-m" "nrepl.cmdline" "--middleware" "[cider.nrepl/cider-middleware]"]}
10979
110-
:cider-cljs {:extra-deps {org.clojure/clojure {:mvn/version "1.10.1"}
80+
:cider-cljs {:extra-deps {org.clojure/clojure {:mvn/version "1.10.3"}
11181
org.clojure/clojurescript {:mvn/version "1.10.339"}
11282
cider/cider-nrepl {:mvn/version "0.49.0"}
11383
cider/piggieback {:mvn/version "0.5.2"}}

0 commit comments

Comments
 (0)