docs: Reorder README to lead with strategies, JSON paths, and row filters#63
Merged
Conversation
Lead with anonymization strategies, conditional column cases, JSON path rules, and row filtering before the full TOML example and CI-oriented sections. Tighten Why Dumpling around flexibility. Move dump seal and hardened security profile detail into the mdBook configuration guide with README cross-links; trim duplicate README sections. 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.
This change reshapes the README so a new reader sees the most distinctive capabilities first: built-in anonymization strategies (with the cheap-vs-realistic guidance), conditional
column_cases, JSON path rules inside columns, and row filtering with the same path semantics.The full TOML example, secret references, strict coverage, residual scan, input formats, policy linting, and notes follow as supporting material.
Dump seal behavior and the hardened security profile are removed from the README body and expanded in the mdBook configuration guide instead, with links from Usage for readers who need that depth. The configuration guide’s anonymization section now points at the README for the per-strategy reference and briefly notes where JSON paths are expanded in-book.
Validation:
cargo fmt --check,cargo clippy --all-targets --all-features,cargo test --all-targets --all-features.Slack Thread