docs: lead Getting started with scaffold-config#69
Merged
Conversation
README and mdBook getting-started now recommend dumpling scaffold-config first (beta), with optional --infer-json-paths and related flags; example policy remains the manual alternative. Co-authored-by: Andy Babic <ababic@users.noreply.github.com>
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
2 participants
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.
Summary
Updates Getting started in the README and mdBook so the recommended first step is
dumpling scaffold-config(beta draft policy from column names), with optional--infer-json-pathsand a short note on related flags. The example config path remains as the manual alternative.Also refreshes the docs home blurb in
docs/src/index.md.Files
README.md— Getting started + two Usage examples forscaffold-configdocs/src/getting-started.md— restructured first-run stepsdocs/src/index.md— new reader hookSlack Thread