Skip to content

docs(content): document type and state lists, the bin and clears - #754

Merged
aicayzer merged 4 commits into
mainfrom
docs/v0.0.50-lists-and-copies
Nov 1, 2026
Merged

aicayzer merged 4 commits into
mainfrom
docs/v0.0.50-lists-and-copies

Conversation

@aicayzer

@aicayzer aicayzer commented Oct 31, 2026 •

Copy link
Copy Markdown
Contributor

Summary

The pages now describe what Marfa v0.0.50 and marfa-swift v0.0.48 changed about listings, the bin, working copies, links and item updates. Items and types is rewritten under its 900-word limit, and the Overview figures' lead-ins now state their facts, because the Markdown copy leaves the figures out.

Closes #712
Closes #714
Closes #718
Closes #726
Closes #728
Closes #709

Part of #717: the link bounds are here; the Swift app tutorial's half comes with the tutorial rewrite.

Part of #698: the status_group term is here; the connector examples' status words are in #759, and the Catalog parts in #755.

#709's Entity page is in #755, so merge that one first or alongside.

Changes

  • List, filter and search (1,497 words, limit 1,500): the status_group term ("everything not yet done", its operators, items in no group) and the properties.<field>.<member> term for a list's entries (eq only, two names, the refusal, in a search, a saved view and a working copy); type takes up to 10 types and state a list or any; blank entries and repeats count for nothing; the refusals for more than 10 types and any beside another state; \" and \\ inside a filter string; a listing of the bin comes most recently binned first; a search never matches an item in the bin.
  • Write in a working copy (1,184 words): a new "Check the copy" section for marfa device status, with synced_at; --type and --state lists; a new "Read the bin" section (offline listing, restore, device items bin); --clear-property and --replace; device follow; a newer CLI keeping an older copy's queue.
  • Items and types (890 words, was 942): rewritten whole. Adds trashed_at and the bin's order. Its ceiling is removed from page-limits.json.
  • Properties and metadata: removing a property with clear_properties, with an example and the two refusals.
  • Marfa MCP server: marfa_update removes the properties named in clear_properties.
  • Files in a folder: a new "Links in a note's body" section with where a link starts and ends, code, backslashes, links to an item in the bin, and embeds.
  • Swift SDK, Items: the link bounds, linking to that section; an item in the bin is never a link candidate.
  • Figure lead-ins on Events, Files, Connectors, Versions, Access and Edges state the fact instead of "The figure shows" or "Pick a key". STYLE.md now says so.

Testing

  • pnpm test: 770 passed. The docs search test first failed for "delete vs purge" and "soft delete trash" after the rewrite folded the "Delete and purge" heading away; the heading is back.
  • pnpm build and pnpm exec vite preview: the changed pages and their .md copies render; Items and types, Files in a folder, Write in a working copy and List, filter and search were looked at at 375 px with no sideways scroll.
  • Claims checked against marfa v0.0.50 (conformance/spec/ items, search-and-filters, device and queue chapters, openapi.json, the CLI's COMMANDS.md) and marfa-swift v0.0.48.

Notes for reviewers

  • "Check the copy" and "Its files" link to Handle files. docs(build): move device files to a guide, bring build guides to limit #759 moves a device's files to a new guide, Keep files on a device; retarget those links once both merge.
  • The CLI's marfa items list, search and export still take one --state, though the server takes a list; the pages show the list only for the HTTP API and for marfa device items.

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 force-pushed the docs/v0.0.50-lists-and-copies branch from af618f4 to a37373a Compare November 1, 2026 00:41
@aicayzer
aicayzer merged commit 4f8a078 into main Nov 1, 2026
8 checks passed
@aicayzer
aicayzer deleted the docs/v0.0.50-lists-and-copies branch November 1, 2026 00:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

1 participant