docs: refresh tracked docs for v0.4.0/v0.4.1 (evidence + OSCAL)#82
Merged
Conversation
The tracked operator-facing docs predated the v0.4.x line and were factually stale. Update: - README.md — `--version` example and Status line 0.3.2 -> 0.4.1; extend the "Shipped since v0.1.0" list with v0.4.0 (structured per-check evidence, `-o evidence:` + `-o oscal:`, NIST conformance gate, live-validated) and v0.4.1 (public OSCAL export on pkg/kensa). - docs/guide/01-install.md — all 0.3.2 references (install --version output, tarball filenames, release-tag URL, cosign example) -> 0.4.1. - docs/guide/07-integration.md — the public-consumer-chain section now documents RuleOutcome.Evidence + ScanResult.Capabilities/Platform (v0.4.0) and the public OSCAL exporters ExportOSCALScan/WriteOSCALScan + ExportOSCAL/WriteOSCAL (v0.4.1); the end-to-end chain now ends at ExportOSCALScan. - docs/guide/04-scan-and-remediate.md — the output-format mention names `-o evidence` and `-o oscal` explicitly. Docs-only; no code change. (CLAUDE.md and docs/roadmap/STATUS.md are gitignored and were refreshed locally in the same pass.) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
Why
The tracked operator-facing docs predated the v0.4.x line and were factually stale (e.g.
01-install.mdtold users to expectkensa 0.3.2).Changes (docs-only, no code)
--versionexample + Status line0.3.2 → 0.4.1; extended the "Shipped since v0.1.0" list with v0.4.0 (structured per-check evidence,-o evidence:+-o oscal:, NIST conformance gate, live-validated) and v0.4.1 (public OSCAL export onpkg/kensa).0.3.2reference (install--versionoutput, tarball filenames, release-tag URL, cosign example) →0.4.1.RuleOutcome.Evidence+ScanResult.Capabilities/Platform(v0.4.0) and the public OSCAL exportersExportOSCALScan/WriteOSCALScan+ExportOSCAL/WriteOSCAL(v0.4.1); the end-to-end chain now ends atExportOSCALScan.-o evidenceand-o oscalexplicitly.Not in this PR (gitignored, refreshed locally in the same pass)
CLAUDE.mdanddocs/roadmap/STATUS.mdgot the comprehensive refresh — milestone date, spec count (114→118), package count (71→73), a new "Resolved during the v0.4.x line" section, repo-layout entries forschemas/+ the new evidence/OSCAL files, four new Key Design Decisions, the Ubuntu-coverage v1.0 gate, and v0.4.0/v0.4.1 STATUS sections. These are gitignored so they can't ship in a PR.🤖 Generated with Claude Code