Skip to content

docs: add CLI output examples reference#48

Merged
CoderDeltaLAN merged 1 commit into
mainfrom
docs/add-output-examples-reference
Jun 16, 2026
Merged

docs: add CLI output examples reference#48
CoderDeltaLAN merged 1 commit into
mainfrom
docs/add-output-examples-reference

Conversation

@CoderDeltaLAN

Copy link
Copy Markdown
Owner

Summary

Adds a dedicated CLI output examples reference for the published v0.2.0 behavior.

This PR:

  • documents representative check output for console, JSON, and Markdown formats;
  • documents check exit-code behavior;
  • records redaction expectations and maintainer guidance for keeping examples honest;
  • links the new reference from the README;
  • updates the README repository layout for docs/RULES.md and docs/OUTPUTS.md.

Scope

Documentation only.

No code, CI, release, tag, PyPI, dependency, or branch protection changes.

Checks

  • ./scripts/check.sh
  • git diff --check
  • staged review of README.md and docs/OUTPUTS.md

@CoderDeltaLAN CoderDeltaLAN merged commit 6a30172 into main Jun 16, 2026
1 check passed
@CoderDeltaLAN CoderDeltaLAN deleted the docs/add-output-examples-reference branch June 16, 2026 05:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant