Skip to content

docs(catalog): open the rule pages with what they cover and cut repeats - #554

Merged
aicayzer merged 3 commits into
mainfrom
docs/rewrite-catalog
Oct 21, 2026
Merged

aicayzer merged 3 commits into
mainfrom
docs/rewrite-catalog

Conversation

@aicayzer

Copy link
Copy Markdown
Contributor

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

  • Type rules (/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.
  • Field kinds (680 to 487 words): opens with what a field kind is and the refusal every kind shares. Each kind states its rule in its own row, datetime and date now 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.
  • Edges (112 to 104 words): opens with what an edge is and links to Properties, metadata and edges. The written_at paragraph 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:status and pnpm types:check pass.
  • Viewed each page with pnpm dev at desktop and 375 px width, and read each .md copy.
  • Checked every rule and refusal code against conformance/spec/types.md, items.md and device.md at marfa v0.0.20.

Notes for reviewers

  • With only chapter links left, the staleness report puts these pages under "chapter changed" rather than naming the rule that changed. That's the cost of moving rule IDs to the footer.
  • The generated per-edge descriptions on Edges are written as the contract writes them ("Source item is about the target item."). That needs a change in marfa's catalog, not here.

Checklist

  • No edits under src/generated/ or to openapi.json
  • No URL changes; inbound anchors kept
  • Every changed page is shorter than on main

@aicayzer aicayzer left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md and edges.md at 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_LINK now 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, system and marfa answer 403; feed expiry is after more than feed_days; the formats row names what it refuses; a device applies these rules; a url also 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.

@aicayzer
aicayzer merged commit 323c7ee into main Oct 21, 2026
6 checks passed
@aicayzer
aicayzer deleted the docs/rewrite-catalog branch October 21, 2026 16:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant