Fork me on GitHub
#polylith
<
2023-10-06
>
tengstrand04:10:22

Hi everyone! We are working on improving the poly tool documentation with help from @lee which does an amazing job! It's still work in progress, but you can have a sneak peek https://cljdoc.org/d/polylith/clj-poly/0.2.18-SNAPSHOT/doc/readme. Make sure to set :mvn/version to "0.2.18-SNAPSHOT" in your ./deps.edn if you want to try it out (instructions https://cljdoc.org/d/polylith/clj-poly/0.2.18-SNAPSHOT/doc/install#use-as-dependency). From now on we build a snapshot version of the next stable release (`0.2.18` in this case) every time something is pushed to the master branch, which is described https://cljdoc.org/d/polylith/clj-poly/0.2.18-SNAPSHOT/doc/ci/polylith-ci-setup. If you find things that is unclear or can be improved in any way, please reach out to us, e.g. in a thread in this post.

1
👍 4
1
seancorfield04:10:15

Great to see this! I know you've put a huge amount of work into it!

seancorfield04:10:59

Could you also provide the git/sha coordinates for the latest 0.2.18 snapshot? I don't like to depend on snapshots...

tengstrand04:10:08

Thanks! Yes, Lee Read, which is also the main maintainer of the cljdoc platform at them moment, really knows his stuff and he is going through everything with some assistance from me. It's also good that he didn't know much about Polylith when he started, so the changes we make are also to make the documentation easier to digest for someone new to Polylith, and also an improved English, because the previous text was mostly written by me who is not a native English speaker. The latest commit in master is 0ff12038a2d81123281d2dc26a6898a6626e72dc which also is the snapshot build for the cljdoc https://cljdoc.org/d/polylith/clj-poly/0.2.18-SNAPSHOT/doc/readme. You need to update that sha every time we push something to master if you want your code to be in sync with the documentation.

lread09:10:06

👋 Hey ho, I'm working my way through the docs sequentially and have just finished the "Doc" doc. The docs were already very good before my changes! I have the benefit of being of poly-ignorant, so I'm editing them from a newcomer's perspective and working with Joakim wherever I am confused (or have misunderstood!).

lread10:10:20

For the SNAPSHOT release sha, I suppose the poly release process could put a sha in the docs, if that's what you are interested in @U04V70XH6. But to be in the docs it would probably have to technically be the sha of the commit before the SNAPSHOT release.

tengstrand06:10:23

Merged 0.2.18-SNAPSHOT #4 to master, with updated https://cljdoc.org/d/polylith/clj-poly/0.2.18-SNAPSHOT/doc/readme (still work in progress).

🙌 1