This page is not created by, affiliated with, or supported by Slack Technologies, Inc.
2022-09-05
Channels
- # asami (13)
- # aws (7)
- # babashka (4)
- # beginners (16)
- # biff (7)
- # cljdoc (10)
- # clojure (32)
- # clojure-europe (27)
- # clojure-nl (14)
- # clojure-norway (7)
- # clojure-uk (3)
- # clojurescript (2)
- # conjure (2)
- # core-async (13)
- # datalevin (4)
- # datomic (3)
- # holy-lambda (7)
- # kaocha (3)
- # lsp (23)
- # off-topic (39)
- # pedestal (10)
- # portal (5)
- # practicalli (2)
- # rdf (10)
- # releases (1)
- # shadow-cljs (66)
- # tools-deps (146)
- # uncomplicate (1)
- # xtdb (10)
Ok. I think it is finally time someone implement the feature to allow updating cljdoc docs after a release.
I volunteer. The last time we talked about this we figured a cljdoc/<version>
tag would work.
See point 8 of https://github.com/cljdoc/cljdoc/issues/459 - reiterated/validated here in https://github.com/cljdoc/cljdoc/issues/31#issuecomment-1177929806. 🧵
Thoughts?: We could apply this to articles only, or do a full rebuild (analysis and articles) or some other variant.
Use cases are:
1) I want to update something like a :git/sha
in my README.
2) I’ve noticed I made a mistake in my docs and want to fix without releasing a new jar.
3) ?
The articles only path might be nice if you’ve made a bunch of code changes on master but you’d like to correct a mistake in your articles on cljdoc for your last release. Articles only would also avoid the issue of jar-sources vs git-sources mis-matches.
Actually I think https://github.com/cljdoc/cljdoc/issues/31 doesn’t talk about docstrings much. And its title sez “Updating Articles after a release” so maybe that’s all folks want?
Pinging those who’ve had an interest in the past: @U04V70XH6, @U5NCUG8NR
Articles are the main point for me at least. The readme is the primary thing I want to update, and this allows adding new articles as tutorials without a new release.
Thanks @U5NCUG8NR!
Also me. I would want to regen the articles (including README, CHANGELOG) but not re-run source analysis. In particular, docstrings should stay in sync with released code since they pop up in editors and should agree with what's (already) on cljdoc.
Good point about docstrings @U04V70XH6, thanks!