Improve organization and content of microsite

[jdegoes]

Some ideas can be found here in PureConfig which does a pretty good job organizing content.

Some ideas:

• Central link on the home page should be "quick start", and it should be a short 1 page file with the bare minimum necessary to get someone started. There will be very little explanation, mostly very tiny code snippets and 1-3 sentences for each code snippet. Quick start will have:
  • How to add project to SBT / Mill / etc. build file
  • How to add optional dependency with Magnolia to SBT / Mill / etc. build file
  • How to create config descriptor (links to "creating config descriptor" section)
    • How to derive descriptor config from data type using Magnolia
    • How to create descriptor config "by hand" with added docs
  • How to specify where config information should be read from (links to "specifying config source" section)
  • How to use config descriptor (links to "using config descriptor" section)
    • How to get readers from config descriptor
    • How to get documentation from config descriptor
    • How to get report generation from config descriptor and value
    • How to get writers from config descriptor
  • How to consume config from from ZIO environment
• Section on creating configuration descriptor
  • Subsection on creating configuration descriptor by hand
  • Subsection on creating configuration descriptor by Magnolia
• Section on specifying config source
  • Specifying source as map
  • Specifying source as properties
  • Specifying source as environment variables
  • Specifying source as hocon file
  • Specifying source as json file
  • Specifying source as yaml file
• Section on using configuration descriptor
  • Subsection on deriving readers for various file formats (properties, env vars, json, yaml, hocon)
  • Subsection on deriving documentation for various formats (html, markdown, plaintext)
  • Subsection on deriving report generation for various formats (html, markdown, plaintext)
  • Subsection on deriving writers for various file formats
• Section on consuming config from ZIO environment
  • The Config module
  • Creating the config module
  • Adding the config module to the whole application environment
  • Accessing application config from anywhere in app using module helpers
• Section on interop
  • Interop with HOCON
  • Interop with etc...

[jdegoes]

@afsalthaj It could be useful to split this ticket up into subtickets, too.

[afsalthaj]

@jdegoes Sure, that's a good idea

[afsalthaj]

@jdegoes , I think we are good without splitting the tasks after giving a giving a kickstart to re-organising the website.

The commits can be seen in documentation branch
https://github.com/zio/zio-config/tree/documentation

[afsalthaj]

The above changes were actually made and merged

[afsalthaj]

Will close the issue, once we review with @jdegoes

[afsalthaj]

@jdegoes Could we review the website again?