Repository navigation
docs(catalog): open the rule pages with what they cover and cut repeats - #554
Merged
Merged
Conversation
aicayzer
commented
Oct 21, 2026
aicayzer
left a comment
Contributor
Author
There was a problem hiding this comment.
Review: ready to merge
Summary. Opens Type rules and Field kinds with what they cover, states each kind's rule in its row, moves inline rule links to footers and adds an opening to Edges; true against marfa v0.0.20, with the catalog test now checking footer links.
First draft: 4/5. No blocking finding; quick fixes that mattered, in a2ca5e4.
Checked.
- True: every refusal code, kind and rule against
types.md,items.md,device.md,housekeeping.mdandedges.mdat v0.0.20. - Every path: inbound anchors to Type rules still exist; nothing links to the removed
field-kinds#values.
Found.
- The lowered test floor left footer links unchecked.
RULE_LINKnow matches chapter links without an anchor and fails on a chapter missing from the contract index; the floor is back above 10, and a new test requires each rule page's footer. A broken footer link was shown to fail. Fixed in a2ca5e4. - Reserved roots, retention and formats overstated or blurred.
core,systemandmarfaanswer403; feed expiry is after more thanfeed_days; the formats row names what it refuses; a device applies these rules; aurlalso loses tabs and line breaks. Fixed in a2ca5e4.Untrue against marfa
Quick fixes. 6 applied by the reviewer.
Reviewed by withmarfa-reviewer on claude-sonnet-5-5. This review may contain mistakes.
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
Gives the three catalog rule pages an opening that says what each covers, and cuts what they repeated: per-row contract links, about 25 restated refusal codes, the identifier namespaces from Items and types, and rare value rules that belong in the contract.
Changes
/catalog/your-own-types, 1,039 to 825 words): opens with the default refusal,400 invalid_schema, so rows name only other answers. Row labels are plain text, not links to contract rules. The identifier section keeps the exact grammar and the reserved roots, and links to Items and types for namespaces. Every heading other pages link to is kept.datetimeanddatenow say how they differ, and the Formats rows have plain labels. The Values table's rare URL host cases move to the contract, named in the footer.written_atparagraph is shorter.src/lib/catalog.test.ts: the link check's floor drops from more than 10 rule links to more than 0, and the field-kinds row pattern no longer expects a link, because the catalog pages now link to contract chapters in their footers.Testing
pnpm test(364 tests),pnpm build,pnpm build:statusandpnpm types:checkpass.pnpm devat desktop and 375 px width, and read each.mdcopy.conformance/spec/types.md,items.mdanddevice.mdat marfa v0.0.20.Notes for reviewers
Checklist
src/generated/or toopenapi.jsonmain