[nongnu] elpa/cider 821d538508 4/8: Update documentation to reflect clojure-ts-mode support

[ELPA Syncer]

branch: elpa/cider
commit 821d538508dff5177cdc32b2cba2f9925ccf8bad
Author: Danny Freeman <danny@dfreeman.email>
Commit: Bozhidar Batsov <bozhidar@batsov.dev>

    Update documentation to reflect clojure-ts-mode support
    
    Particularly the caveats page, where we describe some of the things
    clojure-ts-mode is currently lacking.
---
 CHANGELOG.md                                    |  3 +++
 doc/modules/ROOT/pages/additional_packages.adoc |  2 +-
 doc/modules/ROOT/pages/caveats.adoc             | 14 ++++++++++++++
 doc/modules/ROOT/pages/index.adoc               |  7 +++----
 doc/modules/ROOT/pages/usage/cider_mode.adoc    |  9 ++++++++-
 5 files changed, 29 insertions(+), 6 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 3180f5a10f..72acdeab7b 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -156,6 +156,9 @@ but without connecting to the started nREPL server.
 - Add new customization variable 
[`cider-clojurec-eval-destination`](https://docs.cider.mx/cider/cljs/up_and_running.html#working-with-cljc-files)
 to allow specifying which REPL .cljc evals are sent to.
 - [#3354](https://github.com/clojure-emacs/cider/issues/3354): Add new 
customization variable 
[`cider-reuse-dead-repls`](https://docs.cider.mx/cider/usage/managing_connections.html#reusing-dead-repls)
 to control how dead REPL buffers are reused on new connections.
 - Basic support for using CIDER from 
[clojure-ts-mode](https://github.com/clojure-emacs/clojure-ts-mode) 
+- [#3461](https://github.com/clojure-emacs/cider/pull/3461) Basic support for 
using CIDER from 
[clojure-ts-mode](https://github.com/clojure-emacs/clojure-ts-mode) 
+  - The clojure-mode dependency is still required for CIDER to function
+  - some features like `cider-dynamic-indentation` and 
`cider-font-lock-dynamically` do not work with clojure-ts-mode (yet).
 
 ### Bugs fixed
 
diff --git a/doc/modules/ROOT/pages/additional_packages.adoc 
b/doc/modules/ROOT/pages/additional_packages.adoc
index 6dce41e710..1e1e0a142b 100644
--- a/doc/modules/ROOT/pages/additional_packages.adoc
+++ b/doc/modules/ROOT/pages/additional_packages.adoc
@@ -2,7 +2,7 @@
 
 There are many additional Emacs packages that can enhance your Clojure 
programming
 experience. The majority of the minor modes listed here should be enabled for 
both
-`cider-repl-mode` and `clojure-mode` for optimal effects.
+`cider-repl-mode`, `clojure-mode`, and `clojure-ts-mode` for optimal effects.
 
 The packages listed here belong to three categories:
 
diff --git a/doc/modules/ROOT/pages/caveats.adoc 
b/doc/modules/ROOT/pages/caveats.adoc
index 6eb754121a..93ec792004 100644
--- a/doc/modules/ROOT/pages/caveats.adoc
+++ b/doc/modules/ROOT/pages/caveats.adoc
@@ -83,3 +83,17 @@ provide the dependencies by editing your 
`~/.lein/profiles.clj` as described in
 the xref:basics/middleware_setup.adoc#setting-up-a-standalone-repl[standalone 
REPL] section.
 * Adjust the value of `cider-injected-nrepl-version` to the same nREPL version 
as the
 one that's bundled with Leiningen.
+
+== Clojure-ts-mode integration
+
+Cider has basic support for working with
+https://github.com/clojure-emacs/clojure-ts-mode[clojure-ts-mode] buffers, but 
it still depends on
+https://github.com/clojure-emacs/clojure-mode[clojure-mode] for certain 
functionality, like
+extracting information about clojure code out of the buffer. We hope to make 
clojure-ts-mode capable
+of providing cider with all the functionality it needs to interact with 
clojure buffers, but that
+will take some time.
+
+Additionally, some features like
+xref:config/indentation.adoc#dynamic-indentation[`cider-dynamic-indentation`]
+and 
xref:config/syntax_highlighting.adoc#dynamic-syntax-highlighting[`cider-font-lock-dynamically`]
+are not supported by clojure-ts-mode.
diff --git a/doc/modules/ROOT/pages/index.adoc 
b/doc/modules/ROOT/pages/index.adoc
index 5ddaadc422..394fe12cfb 100644
--- a/doc/modules/ROOT/pages/index.adoc
+++ b/doc/modules/ROOT/pages/index.adoc
@@ -5,10 +5,9 @@ that **R**ocks!
 
 CIDER extends Emacs with support for 
xref:usage/interactive_programming.adoc[interactive programming] in Clojure. The
 features are centered around xref:usage/cider_mode.adoc[cider-mode], an Emacs 
minor-mode that complements
-https://github.com/clojure-emacs/clojure-mode[clojure-mode]. While 
`clojure-mode` supports editing Clojure source files,
-`cider-mode` adds support for interacting with a running Clojure process for
-compilation, debugging, definition and documentation lookup, running tests and
-so on.
+https://github.com/clojure-emacs/clojure-mode[clojure-mode] and 
https://github.com/clojure-emacs/clojure-ts-mode[clojure-ts-mode].
+While `clojure-mode` supports editing Clojure source files, `cider-mode` adds 
support for interacting with a running Clojure process for
+compilation, debugging, definition and documentation lookup, running tests and 
so on.
 
 .Inspired by SLIME
 ****
diff --git a/doc/modules/ROOT/pages/usage/cider_mode.adoc 
b/doc/modules/ROOT/pages/usage/cider_mode.adoc
index c70dd5a2df..a1282fd53e 100644
--- a/doc/modules/ROOT/pages/usage/cider_mode.adoc
+++ b/doc/modules/ROOT/pages/usage/cider_mode.adoc
@@ -18,7 +18,14 @@ it, so you can be productive.
 (add-hook 'clojure-mode-hook #'cider-mode)
 ----
 
-NOTE: There's no need to enable it explicitly for modes derived from 
`clojure-mode` like `clojurescript-mode`.
+or if you are using `clojure-ts-mode`
+
+[source,lisp]
+----
+(add-hook 'clojure-ts-mode-hook #'cider-mode)
+----
+
+NOTE: There's no need to enable it explicitly for modes derived from 
`clojure-mode` or `clojure-ts-mode` like `clojurescript-mode` and 
`clojurescript-ts-mode`.
 
 == Disabling cider-mode