The host client config.yaml has loads of settings, but the docs don't have a reference page explaining what they do. The quickstart mentions a handful of fields and the (new) event filter guide covers that section well. But if you're trying to understand something like pruner.docs_per_block, shinzo.wait_for_gaps, defradb.store.block_cache_mb, or host.snapshot.*, there's nothing to look at.
We're gonna make a dedicated reference page covering every possible field in config.yaml. Each entry should include the field name, type, default value, and a short description of when you'd change it. Something like:
| Field |
Type |
Default |
| defradb.url |
string |
"localhost:9181" |
Task
What's not included
We don't need to create a new tutorial or guide showing how to use each of the fields. That's for another issue entirely.
The host client
config.yamlhas loads of settings, but the docs don't have a reference page explaining what they do. The quickstart mentions a handful of fields and the (new) event filter guide covers that section well. But if you're trying to understand something likepruner.docs_per_block,shinzo.wait_for_gaps,defradb.store.block_cache_mb, orhost.snapshot.*, there's nothing to look at.We're gonna make a dedicated reference page covering every possible field in
config.yaml. Each entry should include the field name, type, default value, and a short description of when you'd change it. Something like:Task
/reference/host-configurationWhat's not included
We don't need to create a new tutorial or guide showing how to use each of the fields. That's for another issue entirely.