docs(config): add CONFIG.md and move the configuration reference out of the README (#119)

CONFIG.md documents every section of sprout.toml, the command line options, BLS support and strict mode. The README keeps the overview and minimal examples and links to it. Adds an update-config-docs skill to keep the reference in sync with the code.
This commit is contained in:
alex authored and GitHub committed 2026-10-04 14:14:13 -07:00
1 parent 9ac55ada50
commit ea115d3a16
5 files changed
+670 -195

No files matched your search

+1 -1
View File
@@ -97,7 +97,7 @@ pub struct OptionsConfiguration {
/// Makes Sprout follow the Boot Loader Specification and systemd-boot exactly where it
/// otherwise differs for convenience or safety. For example, the extended boot loader
/// partition is always read, a one-shot entry only sets the default entry, and entries with
/// missing files are hidden. See the README for everything it changes.
/// missing files are hidden. See CONFIG.md for everything it changes.
#[serde(rename = "bls-strict-mode", default)]
pub bls_strict_mode: bool,
}