docs: add config.toml Configuration section, trim README links, shrink hero image#28
Merged
Merged
Conversation
README: - Add a Configuration section documenting config.toml, including a copy-paste-safe shell snippet (quoted heredoc + sed) that writes the full record/replay/storage/redaction example without mangling regex escapes or requiring manual home-directory substitution. - Include a ready-made [redaction] rules pack covering AI/ML platforms, payment processors, package registries, and database URLs not caught by the built-in detectors. - Drop the Docs CI badge and replace external halfhandorg.github.io links with local docs/*.md references so they don't depend on the Pages site. - Shrink the hero image display to width=120 via an <img> tag. docs/redaction.md: - Point the "ready-made rules" note back at the README's Configuration section instead of duplicating the full example, to keep one source of truth. docs/assets/halfhand-cli.png: - Crop to the logo mark, strip the noisy background to transparency, and downscale (2048x2048/4.94MiB -> 280x280/55KiB).
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.
Summary
config.toml, with a copy-paste-safe shell snippet (quoted heredoc +sed) that writes the full[record]/[replay]/[storage]/[redaction]example without mangling regex escapes or requiring manual home-directory substitution — verified end-to-end againsthh-core's actual TOML parser (byte-exact escaping, correct$HOMEfill-in, valid regex).[redaction] rulespack (AI/ML platforms, payment processors, package registries, DB URLs) that fills gaps the built-in detectors don't cover, perhh-core/src/config.rs.halfhandorg.github.iolinks (badge + 4 prose links) with localdocs/*.mdreferences so the README doesn't depend on the Pages site being live.docs/redaction.mdnow points back to the README's Configuration section instead of duplicating the same block, to keep one source of truth.docs/assets/halfhand-cli.png): removed a noisy background and shrank it from 2048×2048 / 4.94 MiB to 280×280 / 55 KiB, displayed at a fixedwidth="120"in the README.Test plan
config.tomlschema (field names,RedactionRule{name,pattern}shape,Themeenum values) againsthh-core/src/config.rs.sedscript produces byte-exact regex escaping and correct$HOMEsubstitution; parsed the result with Python'stomllibto confirm validity.Cargo.toml,docs/book.toml, CI,RELEASING.md) references ahalfhand.orgdomain, so README links now point at existing local docs files instead.