Skip to content

docs(project): complete installation and usage guide - #48

Draft
batuthzcode wants to merge 3 commits into
mainfrom
agent/readme-usage-documentation
Draft

docs(project): complete installation and usage guide#48
batuthzcode wants to merge 3 commits into
mainfrom
agent/readme-usage-documentation

Conversation

@batuthzcode

Copy link
Copy Markdown
Owner

Summary

  • publish cross-platform installation instructions for Windows, Linux, and macOS
  • document static analyzer text, JSON, exit-code, and severity-gate usage
  • add --fail-on any|info|warning|error support to the static analyzer
  • document live OSV queries and deterministic offline dependency scans
  • describe dependency scanner parameters, output formats, and failure policy
  • document project limitations and security boundaries
  • add contract tests for the public README
  • update the documented test count and coverage result

Verification

  • 1065 tests passed
  • 98.6% combined statement/branch coverage (97% required)
  • sample-app reports are current
  • whole-project self-analysis report is current
  • TOML and GitHub Actions YAML parse successfully
  • Python compileall completed successfully
  • --fail-on error returned 0 for the controlled demo
  • --fail-on warning returned 1 for the controlled demo
  • git diff --check passed

Backlog

Completes Backlog 5.6, including tasks 5.6.1 through 5.6.4.

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