Fork me on GitHub
#polylith
<
2023-09-07
>
tengstrand15:09:54

Hey all! Is there anyone here interested in helping me go through and correct and improve the English for the poly tool documentation in the https://github.com/polyfy/polylith/tree/issue-318 branch? If so, please reply in this thread!

tengstrand15:09:08

@U0J0AC1AT said he could, but I haven't been able to contact him, so I'm making another attempt.

lread15:09:05

I'm tempted. It would help me to become more familiar with polylith! And you'd get a noob perspective when/if I find things confusing. Let's see if j1mr10rd4n chimes in first, could be they got busy elsewhere.

seancorfield15:09:45

I don't know that I'll have time before you're ready to merge it but I will definitely read through and send PRs now that you have it in the repo with the source code.

tengstrand15:09:04

That sounds great! I have waited for about two weeks already and even posted on his Twitter (X I mean!) so please start @UE21H2HHD if you have time! I think it's perfect that you don't know it well, and as you said, it could be a good way to learn it! Take notes if you think things could be clearer, or just change directly! I will be around for questions. Great that you will have a final look at it also @U04V70XH6!

lread15:09:57

Cool, I'll start taking a peek soon.

lread16:09:01

Is all content from http://polylith.gitbook.io going to be migrated? I ask because I see some links to http://polylith.gitbook.io.

lread16:09:17

Or maybe you refactored it throughout?

seancorfield16:09:10

@UE21H2HHD I thought only the tool documentation was moving into the repo and the overview docs were staying in GitBook...?

lread17:09:17

Oh maybe! Dunno.

lread17:09:23

So the idea would be that clj-poly is just an implementation of polylith which needs its own separate general higher level docs?

lread17:09:29

That makes sense, I think! I'll propose a few words around this in clj-poly to avoid confusing dopes like me!

tengstrand21:09:57

The high-level doc https://polylith.gitbook.io will stay as it is (except https://polylith.gitbook.io/poly that now has been moved to GitHub and things have been added and updated). Only look at what's in GitHub, branch issue-318 @UE21H2HHD.

tengstrand21:09:13

The links to the poly tool will be updated in the high-level doc, when clj-poly has been released to cljdoc.

lread21:09:43

Cool, thanks!

👍 2
tengstrand21:09:06

I mean, only update what's in GitHub. Read the high-level doc, but don't use links to the poly tool from there!

lread21:09:23

Yes, that makes sense. Here's my first edit btw https://github.com/polyfy/polylith/pull/327, thought I'd start real slow and small to get a feel for what you want/like.

tengstrand04:09:44

I got contacted by @U0J0AC1AT this morning. He is available to have a look too. I told him that it's great, but that you guys need to sync your changes. You are two different types of users, he has used the poly tool before and know more about Polylith, and you are new to it, so it's great that you @UE21H2HHD helps out fixing the documentation so that it can be understandable for someone new to Polylith! We just have to find a way of working so that you guys don't step on each other's toes! I will open a separate chat for just us in Slack, and we can continue from there. How does that sound?

lread12:09:24

Ya that works.

lread13:09:18

BTW, as part of my noob journey, I just finished reading the https://polylith.gitbook.io/polylith/. Very nice!

tengstrand15:09:47

Okay, cool, hope it made some sense!

lread15:09:14

Yeah, I can tell a ton of work went into it! Great intro and overview!

❤️ 2
tengstrand15:09:00

Thanks! If you have ideas on how to improve, just reach out!

👍 2
lread15:09:16

Small dev thing: babashka is now helpfully letting us know when our tasks override with its built-in commands. And doc is a bb built-in. Options: 1. ya, don't care that we are overriding, am in love with doc as a task name, tell bb to not warn about overrides 2. rename doc to something else, like doc-preview. The longer name might feel like more typing, but it is more descriptive and we all have command completions enabled, right? My pref is 2, but am happy to PR either for you against issue-318 branch.

tengstrand04:09:04

Do 2, if you like!

👍 2
tengstrand16:09:45

Merged!

🎉 2