Skip to content

docs(catalog): document system.view and saving a list as a view - #601

Merged
aicayzer merged 3 commits into
mainfrom
docs/views
Oct 24, 2026
Merged

aicayzer merged 3 commits into
mainfrom
docs/views

Conversation

@aicayzer

@aicayzer aicayzer commented Oct 23, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Documents views, the saved lists of items that withmarfa/marfa#2359 adds as the system.view type and the /views operations. The Catalog gets a system.view page, the list guide says how to save a list as a view, and the API reference lists the Views operations.

Merge this after withmarfa/marfa#2359. The sync here ran against that pull request's branch, so run the sync again from marfa main once it merges and push the result to this branch before merging.

Changes

  • catalog/(system)/view: a new page with the type's title, description and identifier, and its generated file. It links to the guide and to items/system-types, the rule that keeps the item operations from writing a view.
  • guides/list-filter-search: a "Save a list as a view" section, before "When a query is refused". CLI, HTTP and TypeScript tabs create a board view of core.task, grouped by properties.priority, of tasks not completed. It says how to change, delete and read a view, which permissions each needs, how a refused setting is named in details.errors[0].path, and links the views chapter of the contract.
  • api-reference: a Views row after Folders.
  • src/lib/docs-map.test.ts: the system types now include View.
  • Sync: openapi.json, the glossary, the catalog (the new system.view.md, and core.file and core.media from feat(types): core.file.image and core.media declare a thumbnail marfa#2355, already on marfa main), the command tree and the contract index.

Testing

  • pnpm test: 39 files, 700 tests passed. The first run failed on backticks in the new page's description and on the system types listed in the docs map; both are fixed.
  • pnpm build, pnpm build:status and then pnpm types:check pass.
  • Ran the guide's HTTP example with curl against a server booted from feat(server): add system.view and the /views door marfa#2359: it answered 201 with a system.view item. The guide's CLI commands match the command tree (command-check.test.ts); the binary was run for create, change, get and delete, but not with the guide's exact arguments.

Notes for reviewers

  • Every name, error and rule on these pages was checked against conformance/spec/views.md, openapi.json and packages/server/src/routes/views.ts on feat(server): add system.view and the /views door marfa#2359.
  • Review depth: standard. Documentation for a new feature, held by the content lint and the command check.

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 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.

Reviewed with Codex at medium effort after re-syncing from marfa main (6b942076d, the merged /views door): no findings. The view guide and the system.view Catalog page agree with the contract, and openapi.json matches marfa. Docs tests: 700 passed locally.

@aicayzer
aicayzer marked this pull request as ready for review October 24, 2026 02:22
@aicayzer
aicayzer enabled auto-merge (squash) October 24, 2026 02:22
@aicayzer
aicayzer merged commit 6da0f86 into main Oct 24, 2026
8 checks passed
@aicayzer
aicayzer deleted the docs/views branch October 24, 2026 02:25
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