-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Closed
Labels
enhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomers
Description
Is your feature request related to a problem or challenge? Please describe what you are trying to do.
We have a partially automated solution for keeping the configuration guide up-to-date.
When new configs are added in config.rs, we can run cargo run --bin print_config_docs to generate the markdown for the user guide and then manually copy it into docs/source/user-guide/configs.md.
We do not have CI checks to make sure that this is being done when new configs are added.
Describe the solution you'd like
In CI:
- Run
cargo run --bin print_config_docs - Check that there are no modified files
Describe alternatives you've considered
None
Additional context
None
Metadata
Metadata
Assignees
Labels
enhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomers