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

Improve documentation for required values #70

Closed
eddie-knight opened this issue Jan 17, 2024 · 1 comment
Closed

Improve documentation for required values #70

eddie-knight opened this issue Jan 17, 2024 · 1 comment
Assignees
Milestone

Comments

@eddie-knight
Copy link
Contributor

Currently the format for required values is somewhat lacking, as it requires a Ctrl+F to find all the required fields. Then some fields may easily be mis-interpreted as required when they are conditionally required for a block (the block isn't required, but if included then certain keys are subsequently required).

@eddie-knight eddie-knight added this to the v1.1.0 milestone Jan 17, 2024
@eddie-knight eddie-knight self-assigned this Jan 17, 2024
@eddie-knight
Copy link
Contributor Author

This has been somewhat improved in the updated documentation via #96. We should revisit this if anyone is still having difficulty with the clarity around the required fields.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant