Cleanup the docs - Githubissues

clojure-emacs / cider-nrepl

A collection of nREPL middleware to enhance Clojure editors with common functionality like definition lookup, code completion, etc.

https://docs.cider.mx/cider-nrepl

677 stars 176 forks source link

Cleanup the docs #882

Closed alexander-yakushev closed 4 months ago

alexander-yakushev commented 4 months ago

Notable changes:

Removed mentions of Boot as part of the soft-deprecation process (@bbatsov).
Trimmed the compatibility table to leave only versions where compatibilities have changed.

Ignore the 0.49.0 commit, I will rebase it when that PR is merged.

bbatsov commented 4 months ago

Trimmed the compatibility table to leave only versions where compatibilities have changed.

I'm fine with this, but let's add some NOTE: that states this explicitly, so users don't wonder why some versions are absent from the table.

alexander-yakushev commented 4 months ago

Done. I feel like the matrix is still not complete because there is a huge gap between 0.25.0 and 0.44.0 but I'm not sure how to reconstruct the compatibilities of those in-between versions (and if it's worth doing).

bbatsov commented 4 months ago

Done. I feel like the matrix is still not complete because there is a huge gap between 0.25.0 and 0.44.0 but I'm not sure how to reconstruct the compatibilities of those in-between versions (and if it's worth doing).

It's not worth doing IMO. Probably we should cut some cider-nrepl 1.0 soon and just dispense will all the docs for the prior releases (same as I did for CIDER in the past). There's always work to be done on cider-nrepl, but the main API has been reasonably stable for a while now. Probably the only thing we really need to do before it is to namespace the ops as aliases to the existing names. (#710)