Skip to content

Commit 9ced344

Browse files
committed
docs: minor tweaks
1 parent 0c09749 commit 9ced344

28 files changed

+9
-13
lines changed

README.adoc

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -24,16 +24,13 @@ A library that reads and writes Clojure, ClojureScript and https://github.com/ed
2424

2525
*Warning*: v1 Alpha Release
2626

27-
* Migration from https://github.com/lread/rewrite-cljc-playground[rewrite-cljc-playground] complete.
28-
Rewrite-cljc-playground is where I first merged rewrite-clj v0 and rewrite-cljs.
29-
* We are automatically link:#used-in[testing against popular libraries].
30-
We patch them to use rewrite-clj v1 and then run their test suites.
31-
No major issues have been found.
32-
* Please review link:CHANGELOG.adoc[change log] for an overview of all v1 changes.
33-
* I am very conservative on making any further v0->v1 breaking changes, but am open to breaking changes to any of the new v1 work.
34-
35-
We'll move out of alpha after folks have had a chance to give rewrite-clj v1 alpha a good shake.
36-
Things look very solid at this point.
27+
Our first rewrite-clj v1 alpha release was in March of 2021. +
28+
Since then we have seen wide and successful adoption of rewrite-clj v1 with no show-stoppers. +
29+
I would drop the alpha status but have not yet seen the following features get a good shake yet in the wild:
30+
31+
1. zippers with `:track-position?` enabled
32+
1. zippers using `:auto-resolve` support
33+
1. paredit API
3734

3835
See https://github.com/clj-commons/rewrite-clj/projects/1[project page for current priorities].
3936

doc/02-developer-guide.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,8 @@
55
== Supported Environments
66
Rewrite-clj is verified on each push on macOS, Ubuntu and Windows via GitHub Actions.
77

8-
All scripts are written in Clojure and most invoked via https://github.com/borkdude/babashka[babashka].
8+
All scripts are written in Clojure and most invoked via https://github.com/borkdude/babashka[babashka] tasks.
99
This gives us a cross platform scripting language that is familiar, fun and consistent.
10-
These docs will show babashka scripts invoked explicitly via babashka's `bb`; on macOS and linux feel free to leave out `bb`.
1110

1211
We make use of planck for cljs bootstrap (aka cljs self-hosted) testing.
1312
Planck is currently not available for Windows.
2 Bytes
Loading

doc/generated/contributors/PEZ.png

-1 Bytes
Loading
-2 Bytes
Loading

doc/generated/contributors/arrdem.png

8.71 KB
Loading
3 Bytes
Loading
-1 Bytes
Loading
-6 Bytes
Loading
-2 Bytes
Loading

0 commit comments

Comments
 (0)