Repository navigation
docs(catalog): describe status words, ranges, entries, labels and names - #755
Merged
Merged
Conversation
This was referenced Oct 31, 2026
Closed
aicayzer
force-pushed
the
docs/catalog-types
branch
from
November 1, 2026 00:01
87598c2 to
5b62f39
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
The Catalog's type pages now describe what Marfa v0.0.49 and v0.0.50 changed about type definitions: status words and groups, ranges, lists of entries, the currency format, field labels, a type's plural, Iconify icon IDs, and how an item is named and previewed. The Media, Task, Event and Entity pages describe their new fields, each with an example the catalog test checks.
Closes #704
Closes #708
Part of #721: the Build and Run pages that still name a bare icon are fixed by batch 4b.
Part of #697, #698, #705, #706, #707, #709, #710, #715 and #732: the Catalog parts are here. The Build and Run parts come with the Build and Run guides pull request, and the connector parts of #705 and #707 with the connector pages pull request.
Changes
items_fields. "Compatible with" covers status words, entry members, ranges and currency. Theiconhint is an Iconify ID from the pinnedlucideandsimple-iconssets, with what is refused and links to the generated ID lists. The owner's icon example useslucide:chef-hat. Field rules moved to Field kinds.currencyand the uncheckedbcp47,iso3166andphone. It now holds the field-definition rules, so its limit kind inpage-limits.jsonisguide(1,500) rather than its own 600.status, the 1 to 5rating,min_playersandmax_players, and acore.media.gameexample.due_at, elsestarts_at, never unfolded) andassignees. The example uses a real status word.attendees, the four responses, and finding the person by email.emails,phonesandaddressesas lists of entries, with the first entry as the main one.catalog.test.ts: the Field kinds check reads kinds only from the "Kinds" section, since the page now has other tables.Testing
pnpm test: 770 passed. The Field kinds check first failed on the new Definition table's keys; it now reads only the Kinds section.pnpm buildandpnpm exec vite preview: Type rules, Field kinds, Media, Task, Event and Entity and their.mdcopies render, at desktop width and at 375 px with no sideways scroll.v0.0.50:conformance/spec/types.md(the label, plural, status, range, entries, currency, icon, item-name and shipped-type rules),device.md(item names and previews, offline checks),search-and-filters.md(status_group),packages/types/and the CLI'sCOMMANDS.md.Notes for reviewers
labelon a field and on an entry member, buttypes/unknown-keyin the contract does not list it. The pages follow the code; Contract: types/unknown-key omits label from the field and member keys marfa#2561 asks for the contract to match.authored-bymention remains on any page, so Describe Marfa v0.0.49's type definition keys and icon IDs across the docs #721 needed nothing for it. The changelog's icon wording comes from the release notes, which this repository does not edit.Checklist