Repository navigation
docs(catalog): add link field and version policy, and split out display hints - #762
Merged
Merged
Conversation
aicayzer
force-pushed
the
docs/pass-leftovers
branch
from
November 1, 2026 01:13
212316e to
c7e55d4
Compare
aicayzer
force-pushed
the
docs/pass-leftovers
branch
from
November 1, 2026 01:18
c7e55d4 to
7869014
Compare
aicayzer
force-pushed
the
docs/pass-leftovers
branch
from
November 1, 2026 01:21
6959dc6 to
9091520
Compare
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
Type rules now covers
link_fieldandversion_policy, and display hints move to a Catalog page of their own, Display hints, at/catalog/display-hintsin the Types folder. The split gives back the details the first version of this pull request cut to stay within Type rules' limit. The Swift SDK's Server calls page names both icon sets Marfa pins, and Define a type shows the status form of a scaffold field.This pull request is stacked on #764 and targets its branch. Once #764 merges, it retargets to
main.Changes
types/link-field,types/link-field-refused,items/link-taken) and a Version policy section (types/version-policy-values,types/version-policy-order,housekeeping/thinning-policy). Display hints is now a short section that links to the new page. It restores that a newcompatible_withtarget outside the platform needs write on it, while keeping one doesn't (types/compatible-with-reach,types/compatible-with-preserved). It also restores the explanation that a natural-key upsert doesn't restart the feed window. The contract footer drops the device chapter, which only the moved sections used.body_field(types/body-markdown).403 forbiddenand403 type_not_permitted(types/icon-who-refused), along with400 invalid_schemaand404 type_not_found.device/catalog-icon). Deleting a type discards its icon (types/icon-deleted)./catalog/type-rules#display-hints,#names-and-previewsand#the-owners-iconnow points at the matching section of Display hints. These links are on Items and types, Define a type, Change a type, Pull and push, Export and restore, and the Swift SDK's Items and Server calls pages. The Types landing page names the new page.meta.json, inpage-limits.jsonas a guide (like Type rules and Field kinds), and incontent/AGENTS.md. The Catalog test and the docs map test list it./swift-sdk/items#names-and-previews, now resolves against the Reference group instead of failing as broken.lucide:andsimple-icons:as the two pinned Iconify sets.NAME:status:WORD=GROUP,WORD=GROUP, checked againstcore/marfa-cli/COMMANDS.md.Testing
pnpm testpasses (830 tests), including the word limits, the Catalog test and the docs map test.pnpm buildpasses. Invite preview, a crawl of every page indocs-map.mdfound no broken internal link or section link (117 pages).llms-full.txtanddocs-map.mdlist Display hints between Type rules and Field kinds..mdcopy.Notes for reviewers
Every restored detail was checked against the
typesanddevicechapters on marfa'smain.Checklist