Skip to content

docs: 0.7.0 release docs match the code - #247

Merged
ffroliva merged 4 commits into
release/0.7.0from
docs/0.7.0-release-docs
Nov 19, 2026
Merged

ffroliva merged 4 commits into
release/0.7.0from
docs/0.7.0-release-docs

Conversation

@ffroliva

Copy link
Copy Markdown
Owner

The release documentation matches the code on release/0.7.0. Each change below was checked against the cited source.

  • CHANGELOG.md:

    • removes the placeholder line for the command-line client, which duplicated its full entry;
    • SEC-STATIC-001 runs on the Security panel and the CLI sharpit security scan, never over MCP (security_scan is an action tool; MCP lists and serves read tools only);
    • drops a repeated agent-plugin entry (the plugin shipped in 0.6.0);
    • adds the interactive tutorial;
    • gives D6 and E0/fix: --sharpit-app reports an uninspectable app as unknown, not as an empty pass #207 their PLAN.md reasons.
  • website/docs/mcp.md no longer says that no command-line client exists. website/docs/ai-agents.md says that the CLI has every MCP read tool plus the 21 action tools that MCP does not serve.

  • New website/docs/cli.md (in the nav):

    • install, connection options and their environment variables, global options, command groups;
    • --fail-on and exit codes 0/1/2/3 as exit_codes.py, outcomes.py and fail_on.py define them;
    • token redaction.

    Every command on the page parses with the client's own parser. The five violations commands show their required --scan-id <scanId> <id>.

  • website/docs/deviations.md: rows 13 and 23 note that the client implements exit codes 0/1/2/3.

  • ROADMAP.md lists the client, the agent playbooks and guide, MCP prompt arguments with verify_after_change, and the tutorial.

  • README.md lists --no-color and -v/--verbose.

  • docs/reference/PARITY.md: the deviation rows of the client (T2-T8) and G1/G2 are generated from their matrix fragments; the count test is 29 -> 117.

  • Plans: track C, G1 and G2 are ticked, and a ticked G3 line is added. In 2026-11-16-sharpit-cli.md, Tasks 1-8 are ticked; Task 9 (live verification) stays as written.

Gates: mkdocs build --strict; tests/docs, tests/test_agent_workflow.py, tests/test_agent_plugin.py, shard and boundary gates (376 passed); ruff; ruff format.

@ffroliva
ffroliva merged commit 79ba6cd into release/0.7.0 Nov 19, 2026
47 checks passed
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