fix: correct product docs to web-audit library (no CLI/Action)#9
Merged
Conversation
inspect is a website security & accessibility audit library + embeddable MCP server, not a "code security scanner CLI". Made all docs/config honest: - README/docs/architecture/AGENTS.md: rewritten to describe the real web-audit library (a11y/TLS/cookies/security-headers/mixed-content/meta + crawler + MCP). Removed all references to a non-existent inspect-ci/inspect-action CLI binary. - Deleted action.yml + .github/action.yml (composite Action built a non-existent ./cmd/inspect-action) and deploy/docker/docker-compose.yml (referenced a non-existent inspect-ci binary). - api/openapi.yaml: corrected the MCP surface to the real constructor (mcp.New(...).ServeStdio()) and replaced the bogus checks enum with the 6 real checks (security-headers, cookie-security, tls, mixed-content, meta-tags, accessibility); dropped SEO/performance overclaims. - Issue templates: removed deleted GitHub Action options. - CI: pinned gofumpt v0.10.0; Go badge -> 1.26+. Verified: go build/vet/test pass; gofumpt clean; golangci-lint 0 issues; zero dangling CLI/Action references.
The Features list and intro omitted links/forms/perf/seo and the Presets table said 'all checks' without defining it. Document all nine registered checks, mark the six that run in the default presets, and correct the Standard godoc comment. Drop the stale 'GitHub Action' entry from the [Unreleased] bug_report surface-dropdown description (action.yml was removed in this PR).
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.
Summary
inspectis a website security & accessibility audit library + embeddable MCP server, not a "code security scanner CLI". This PR makes all docs and config honest about the real product surface.Changes
inspect-ci/inspect-actionCLI binary.action.yml+.github/action.yml(composite Action built a non-existent./cmd/inspect-action) anddeploy/docker/docker-compose.yml(referenced a non-existentinspect-cibinary).mcp.New(...).ServeStdio()) and replaced the bogus checks enum with the 6 real checks (security-headers,cookie-security,tls,mixed-content,meta-tags,accessibility); dropped SEO/performance overclaims.Verification
go build/go vet/go testpass