spec(oddkit): add oddkit_audit specification (DRAFT v2 — KISS)#140
Closed
spec(oddkit): add oddkit_audit specification (DRAFT v2 — KISS)#140
Conversation
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
Lands the
oddkit_auditaction specification (DRAFT v2 — KISS) as committed canon atdocs/oddkit/specs/oddkit-audit.md.This is PR-1.2 of the link-rot-elimination campaign.
What it specifies
One thin action with one check (two
rule_ids):dead-reference—klappy://URI returns NOT_FOUND fromoddkit_resolvelegacy-link-pattern—[label](/page/...)or[label](./relative.md)inwritings/Both severity
errorby default. Allowlist via line-level<!-- audit-allow: <rule-id> reason="..." -->directives only.Partial-data compliant. Backward-compatible (net-new action). Calls
oddkit_resolve(PR-1.1) for the dead-reference rule.What it explicitly does NOT include
Per Vodka discipline / Use Only What Hurts:
audit_allow:frontmatter fieldEach is a real concern with an explicit revisit condition in the deferred-concerns ledger (PR-1.3). The reported pain was broken links; the spec solves that. Other concerns become their own thin actions when their pain is acute.
Lineage
audit_allow:fieldImplementation timing
This PR lands the specification. Implementation is PR-2.3 of the campaign and is gated on E0008.3 release-validation-gate.
Next in the campaign
canon/principles/identity-resolved-by-protocol.md) + deferred-concerns ledger + campaign sequencing docNote
Low Risk
Documentation-only change that adds a new spec; no runtime behavior or CI wiring is modified in this PR.
Overview
Adds a new draft spec,
docs/oddkit/specs/oddkit-audit.md, defining theoddkit_auditaction for PR-time link integrity auditing.The spec defines inputs/outputs, two finding rules (dead
klappy://URIs viaoddkit_resolve, and banned legacy link patterns inwritings/), a line-levelaudit-allowsuppression directive, and partial-index/partial-data reporting expectations.Reviewed by Cursor Bugbot for commit f603f79. Bugbot is set up for automated code reviews on this repo. Configure here.