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 Profile doc #388

Closed lread closed 8 months ago

lread commented 8 months ago

Describe the purpose of profiles early and succinctly (and hopefully, correctly!).

Add separate InkScape SVGs for all hand-crafted diagrams. Adapted from source SVG provided by Joakim. Switched to cross-OS friendly fonts in SVGs. Resized boxes and fonts for consistency across all images. Added dotted box around Development and Production environments for extra clarity. Cljdoc does not have a dark theme, but GitHub does, so I put some effort into making images dark-theme-friendly.

Hand-crafted SVG image text is now more explicit to avoid ambiguity. Added suffixes "Env" (for environments), "project", and "profile".

Annotated info screenshots with orange boxes to focus the reader output relevant to docs.

No longer assuming everybody uses Cursive by moving Cursive specific guidance to adoc tips.

With the idea that simpler is better for our examples, reduced number of logging libraries used in examples from 2 to 1.

Added one more poly info example to show default profile selection.

Added sections and toc.

And many other changes.

lread commented 8 months ago

@tengstrand, thanks for the thoughtful feedback, I left conversations open that require another review from you.