Repository navigation
docs: align README and mdBook with recent features - #85
Merged
Merged
Conversation
Bring changelog, lint tables, configuration guide structure, and the example policy in sync with keep, not_* operators, fail-closed regex, and the audit sidecar so recent features read alongside existing ones. Co-authored-by: andy <andy@wearecrew.com>
Align shared domain strategies, cover listed sensitive columns, and keep the example as a clean starter that lint-policy accepts with env salts. Co-authored-by: andy <andy@wearecrew.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
Review and refresh README / mdBook / changelog / example policy so recently landed features (
keep,not_*predicates, fail-closed regex +invalid-regex-predicate, audit--report/--no-seal, design rationale) are documented consistently alongside existing strategies and CI gates.Changes
keep, negating predicates, fail-closed regex, lint check; backfillblank/empty_array/empty_objectunder 0.7.0 (shipped with#62).invalid-regex-predicateto lint tables; link Design rationale from Full documentation; point Getting started atkeep/ lint checks.keep/ clears /decimal/payment_cardnext to the strategy pointer..dumplingconf.example: operators list,blank/ empty JSON path examples, first-matchkeepcase, shared-domain strategy alignment, and rules covering listed[sensitive_columns]solint-policyis clean.Testing
./scripts/setup-dev.sh.tools/mdbook build— successDUMPLING_GLOBAL_SALT=… dumpling lint-policy -c .dumplingconf.example— no violationsDocs-only; no runtime code changes.