docs: document On-Demand Scan API and new env vars (weekly audit) - #16
Merged
Conversation
…N_API_SECRET, POST /scan)
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
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.
Weekly Documentation Audit — 2026-05-12
Documentation Gaps Addressed
The On-Demand Scan API was merged (PR #12) but
README.mdhad no mention of the two new environment variables, thescan_apiYAML config block, or thePOST /scanendpoint.KK_PROBE_SCAN_API_ENABLEDnot in env var tablefalseKK_PROBE_SCAN_API_SECRETnot in env var tablescan_apiYAML block missing from config referenceenabledandsecretfieldsPOST /scannot mentioned in How It Works diagramopenssl rand -hex 32exampleFiles Changed
README.md— env var table, YAML config block, new On-Demand Scan API section, How It Works diagram, troubleshooting sectionSuggested Version Bump
The scan API was already merged in PR #12. If not yet tagged, release
v0.2.0— the on-demand scan endpoint is a new externally-facing feature, warranting a minor version bump per semver.Generated by Claude Code