search

polyfy / polylith

A tool used to develop Polylith based architectures in Clojure.
Eclipse Public License 1.0
523 stars 47 forks source link

Review and update Introduction #330

Closed lread closed 1 year ago

lread commented 1 year ago

Moved link to cljdoc to a tip that is only displayed if not already reading on cljdoc. Cljoc link adjusted to point to article we are viewing (introduction) instead of readme.

Same content but re-organized.

Starts with goal, then show the details to further entice reader.

Used bullet points to make text easier to digest.

Tried to be more succinct by getting rid of unnecessary words or rephrasing to use less words.

lread commented 1 year ago

@tengstrand my proposal for changes to the Introduction. Lemme know what you think.

lread commented 1 year ago

Due to some GitHub glitch, @tengstrand's PR feedback never made it to this PR. But he shared the following on Slack:

image

image

image

lread commented 1 year ago

Yeah, that's fine. Can do. Not trying to make the text my own, but clearer and easier to digest, but these things are subjective, so I'm happy to tweak.

lread commented 1 year ago

@tengstrand re:

The only feedback on the two versions she gave me was that it should be an s in "one of the hardest and most important things".

I don't see this text.