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 Configuration doc #395

Closed lread closed 8 months ago

lread commented 8 months ago

Introduce user and poly config as separate categories.

Include filename in section headings.

Group all deps.edn config section headings under a new section heading.

Explain how each config file is initially created and how it is changed.

Clearly mark derived configuration.

Show default config values when appropriate.

Add note that output in doc might not always match output if following along in tutorial (for illustrative purposes). That said, update output to better match actual output.

Ensure that :key-names do not wrap in tables.

Link to other docs when helpful.

Fix some typos.

Edits for clarity.

lread commented 8 months ago

@tengstrand, ready for review and feedback! As always, please read the commit comment carefully before reviewing.

lread commented 8 months ago

Ok @tengstrand, I merged in your changes and addressed all review feedback!