Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Config reference #3367

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

docs: Config reference #3367

wants to merge 10 commits into from

Conversation

igneus
Copy link
Contributor

@igneus igneus commented Feb 27, 2025

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.Config attempt to generate the table results in stack overflow.

/claim #2431

@igneus igneus force-pushed the config-reference branch from d802319 to c1eb78b Compare March 2, 2025 02:07
@igneus
Copy link
Contributor Author

igneus commented Mar 2, 2025

ZClient.Config is not included, as an attempt to generate its documentation results in stack overflow (zio/zio-config#1545).

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 igneus marked this pull request as ready for review March 4, 2025 18:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant