search

polyfy / polylith

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

Review and update Dependencies doc #389

Closed lread closed 8 months ago

lread commented 8 months ago

Add more sections and toc.

Moved notes on ws-dir to Exploring the Workspace doc (as adoc comment for now, I'll integrate when I get to that doc).

Now generating screenshots with polyx from create_example.clj.

In Clojure we typically think of "dependencies" as 3rd-party library dependencies. Because "dependencies" means something different in the world of poly, I added more words here and there distinguishing the difference.

Annotated first deps screenshot to emphasize uses vs used-by.

Doc talked about what yellow means but did not mention other colors, so I filled in that gap.

Switch from ssh to https for git clone so that clone will work for readrs that don't have ssh creds setup.

Other edits for clarity.

lread commented 8 months ago

@tengstrand Ready for your review and feedback. As usual, please read over the commit message first for an overview of the changes I made. Also, please give a little extra time to the Accessibility section to make sure the changes I made to the Caution column are correct.