Skip to content

docs(catalog): describe status words, ranges, entries, labels and names - #755

Merged
aicayzer merged 2 commits into
mainfrom
docs/catalog-types
Nov 1, 2026
Merged

aicayzer merged 2 commits into
mainfrom
docs/catalog-types

Conversation

@aicayzer

@aicayzer aicayzer commented Oct 31, 2026 •

Copy link
Copy Markdown
Contributor

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

  • Type rules (1,461 words, limit 1,500): rewritten whole. New "Label and plural" and "Names and previews" sections, and a "Status words" section on how a subtype adds words. The inheritance table now covers labels, ranges, status words and items_fields. "Compatible with" covers status words, entry members, ranges and currency. The icon hint is an Iconify ID from the pinned lucide and simple-icons sets, with what is refused and links to the generated ID lists. The owner's icon example uses lucide:chef-hat. Field rules moved to Field kinds.
  • Field kinds (1,117 words): rewritten whole. A new "Definition" table of every key a field takes, then sections for status words, ranges, lists of entries and formats, including currency and the unchecked bcp47, iso3166 and phone. It now holds the field-definition rules, so its limit kind in page-limits.json is guide (1,500) rather than its own 600.
  • Media (117 of 150): progress and how it differs from a series' status, the 1 to 5 rating, min_players and max_players, and a core.media.game example.
  • Task (131 of 150): recurrence (starts at due_at, else starts_at, never unfolded) and assignees. The example uses a real status word.
  • Event (111 of 150): attendees, the four responses, and finding the person by email.
  • Entity (140 of 150): emails, phones and addresses as lists of entries, with the first entry as the main one.
  • Items and types: the icon sentence names Iconify IDs.
  • 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 build and pnpm exec vite preview: Type rules, Field kinds, Media, Task, Event and Entity and their .md copies render, at desktop width and at 375 px with no sideways scroll.
  • Claims checked against marfa 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's COMMANDS.md.

Notes for reviewers

Checklist

  • The title is a scoped Conventional Commit.
  • New behavior has a test that was seen failing first, or no test was needed and the reason is above.
  • Docs, comments and the contract still say what is true after this change.

@aicayzer
aicayzer merged commit c20d3b8 into main Nov 1, 2026
8 checks passed
@aicayzer
aicayzer deleted the docs/catalog-types branch November 1, 2026 00:03
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.

The Media page describes rating and the game type The Media page describes progress and how it differs from a series' status

1 participant