Rewrite README: CLI reference, run modes, status UI, troubleshooting, FAQ - #75
Merged
Merged
Conversation
… FAQ Documents all five subcommands (init was undocumented), every config key with enforced rules, and the real run modes: full, headless, API-without-probing via enabled:false, ephemeral :memory:, validate-only. API table gains the true incident query params; every yaml block is a complete valid config per the check-docs gate.
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.
Documents the binary as it actually behaves (every claim checked against code): full CLI reference including the previously undocumented
init, complete config reference, five run modes, status UI routes, corrected incident query params, troubleshooting + FAQ. All yaml blocks are complete valid configs under the check-docs gate.