docs: Config reference #3367
docs: Config reference #3367
Conversation
because Table.toGithubFlavouredMarkdown() assumes it owns the page and the anchor IDs clash when multiple configs are dumped on a single page
|
Please note that the output is affected by zio/zio-config#1542 , which is also source of the broken links reported by docusaurus. PR with a fix is linked to the issue. |
igneus
requested review from
jdegoes,
vigoo,
kyri-petrou and
987Nabil
as code owners
|
@igneus I just hit publish on zio-config. Can you update it once it is released? |
|
@987Nabil Thanks, done.
# <a name="custom-heading-anchor"></a>Heading Textand that's rather ugly. |
* docs: Config reference * scalafmt * scalafix * simplify * delete entries of configs which only appear nested in others * make zio-http-gen visible to zio-http-docs * docs: Config reference: each config on a separate page because Table.toGithubFlavouredMarkdown() assumes it owns the page and the anchor IDs clash when multiple configs are dumped on a single page * website: sidebar: fix document IDs * docs: Config reference: shorten sidebar labels * docs: Config reference: introduction page * Update zio-config to 4.0.4 --------- Co-authored-by: Nabil Abdel-Hafeez <[email protected]>
For a start of #2431 here's the Config reference page generated using the approach outlined in the issue description.
Unfortunately the contents generated this way are more confusing than helpful (even the FieldName table cells are often empty, the other contents, if available, are rather enigmatic). And for
ZClient.Configattempt to generate the table results in stack overflow./claim #2431