Repository navigation
docs(config): add CONFIG.md and move the configuration reference out of the README - #119
Merged
Merged
Conversation
…of the README 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.
# Conflicts: # README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README had grown a partial configuration reference: command line options, BLS, loader.conf, strict mode and one generator example, with nothing on drivers, extractors, actions, phases or most entry and generator keys.
CONFIG.md now documents the whole of sprout.toml, written against the code in crates/config and crates/boot, along with the command line options, value substitution, autoconfiguration, BLS support and strict mode. The README keeps the overview, features and two minimal examples, and links to it.
Also adds an update-config-docs skill so CONFIG.md gets updated when the config changes, and points CLAUDE.md and a doc comment in crates/config at the new file.