docs(specs): add W3C-style usage specification#593
Merged
Conversation
Introduce specs/usage-spec.md, a W3C-style normative usage/integration specification for the threat-detect CLI (U-01..U-28). It defines how a conforming host acquires the release-asset binary, invokes the detector, runs it inside the AWF sandbox, and concludes a run, referencing the detection behavior spec via TD-XX to avoid duplication. Link the new spec from README.md and CLAUDE.md. Closes #383 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: David Slater <12449447+davidslater@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a normative usage specification for integrating threat-detect.
Changes:
- Defines acquisition, invocation, sandboxing, conclusion, and compatibility requirements.
- Links the specification from project documentation.
Show a summary per file
| File | Description |
|---|---|
specs/usage-spec.md |
Adds the usage specification. |
README.md |
Links and describes the new specification. |
CLAUDE.md |
Adds the specification to repository guidance. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 3/3 changed files
- Comments generated: 2
- Review effort level: Medium
- U-04: remove the internal contradiction with U-24/U-26 by keeping the MUST pin requirement and requiring latest to be resolved to a concrete release tag before download (no unpinned "latest" download). - U-22: include output_write_error among the exit-2 reasons that may fail the detection step, since an unwritten verdict may have contained a threat and must not be treated as a recoverable missing report. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: David Slater <12449447+davidslater@users.noreply.github.com>
This was referenced Jul 21, 2026
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
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
Closes #383.
Adds a W3C-style Usage Specification (
specs/usage-spec.md) for thethreat-detectcomponent. Where the existing threat-detection-spec.md defines what the detector does (detection behavior and result contract), this new spec defines how a host acquires, invokes, and concludes a detection run — giving integrators a single normative reference to simplify integration.What's included
U-01..U-28using RFC 2119 language, mirroring the format of the existing spec.TD-XXrather than duplicating it; the usage spec explicitly does not weaken or override anyTD-XXrequirement.README.md(Specification section + Architecture tree) andCLAUDE.md.Notes
Documentation-only change — no code, build, or test impact.