docs: README Getting started section#64
Merged
Merged
Conversation
Introduce a short numbered path from example config to first run and linting, with pointers to the example file, config discovery, and docs. Add a planned draft policy generation note for future tooling. Co-authored-by: Andy Babic <ababic@users.noreply.github.com>
ababic
force-pushed
the
cursor/readme-getting-started-4584
branch
from
f7dd669 to
e30b5e7
Compare
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
Adds a Getting started section immediately after Install so new readers get a short, ordered path: copy
.dumplingconf.example, align rules with dump identifiers, run Dumpling, then tighten withlint-policyand optional strict gates.Includes a Draft policy generation (planned) paragraph so the future dump-driven starter TOML is framed as a time-saver and explicitly draft / review-required, matching the product direction discussed.
Testing
cargo fmt --all -- --checkcargo clippy --all-targets --all-featurescargo test --all-targets --all-featuresSlack Thread