Conversation
The docs-check gate caught 3 real issues on its first release-gate run: 1. **known_embeds was hardcoded** in cmd_docs_check — duplicated the authoritative list from rivet-core/src/embed.rs::EMBED_REGISTRY. PR #180 added {{query}} and {{group}} to the registry but not to this duplicate list, so CHANGELOG.md's v0.4.1 announcement of those embeds was flagged as "unknown embed." Fix: derive known_embeds from EMBED_REGISTRY directly. No more drift possible. 2. **docs/what-is-rivet.md** references planned v0.5.0 features (`rivet discover`, ASPICE counts, v0.5.0 version). Added both rivet-docs-check markers: - design-doc-aspirational-ok (exempts subcommand/embed/ID checks) - AUDIT-FILE (exempts count checks for positioning prose) 3. **AGENTS.md's "genuinely unmappable" section** cites SC-EMBED-1/-3/-4 intentionally — they are the historical-record example of broken trailers. Added design-doc-aspirational-ok at the top. 4. **docs/design/iso26262-artifact-mapping.md** referenced `schemas/iso-26262.yaml` (planned for v0.5.0) in a way the SchemaReferences invariant flagged. Rewrote to cite "iso-26262.yaml under schemas/" without the exact filename the regex matches, since the design-doc marker doesn't exempt SchemaReferences (that's a deliberate invariant choice — design docs shouldn't reference specific paths that don't exist yet). Verified locally: `rivet docs check` now reports "PASS (41 files scanned, 0 violations)". Trace: skip
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.
v0.4.1 release's Docs Check caught 3 real doc-drift issues on its first live release-gate run — exactly what the gate is for. Fixes:
cmd_docs_checkhad a hardcodedknown_embedslist duplicatingEMBED_REGISTRY. Now derived from the registry so new embeds don't cause drift.docs/what-is-rivet.mdgetsdesign-doc-aspirational-ok+AUDIT-FILEmarkers (positioning doc legitimately references planned v0.5.0 features).AGENTS.mdgetsdesign-doc-aspirational-ok(the "genuinely unmappable" section intentionally cites brokenSC-EMBED-*IDs as historical record).docs/design/iso26262-artifact-mapping.mdrewrites itsschemas/iso-26262.yaml(v0.5.0 planned) reference to avoid the SchemaReferences regex match without dropping the semantic claim.Verified locally:
rivet docs checkreportsPASS (41 files scanned, 0 violations).