Skip to content

docs(guides): describe views as a query with a sort and group - #620

Closed
aicayzer wants to merge 3 commits into
mainfrom
feat/views-no-layouts
Closed

aicayzer wants to merge 3 commits into
mainfrom
feat/views-no-layouts

Conversation

@aicayzer

@aicayzer aicayzer commented Oct 24, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Views hold a query, a sort and an optional group, and no layouts. This updates the guides, the CLI reference, the devices overview, the API reference and the view catalog description to match withmarfa/marfa#2391. It merges only after that change is released and synced into these docs.

Changes

  • list-filter-search: "Save a list as a view" shows sort and group in the CLI, HTTP and TypeScript, and notes that a folder is filtered with edge[in-folder] or source.
  • list-filter-search also says a view's grouping is removed with group: null or marfa views change --group null.
  • read-a-view: removes layouts and sum, drops --layout, and says a working copy answers a backref condition where it holds that edge type whole.
  • cli, devices, api-reference/index: word the view commands and the offline reads without layouts.
  • catalog/(system)/view: the description now matches the new system.view type.

Testing

  • The docs build and pnpm test were not run. Expect CI to fail until the Marfa release is synced: the catalog description check and the CLI command check read synced files (view.json, COMMANDS.md) that still describe layouts. Do not run scripts/sync-from-marfa.sh for this change.
  • I checked each command, flag and key in the changed pages against the Marfa branch's COMMANDS.md, openapi.json and view.json, and searched the content for the removed words.

Notes for reviewers

  • swift-sdk.mdx still describes layouts on SavedView. It follows the Swift SDK change, which another piece of work makes, so I left it. The Swift lines in read-a-view assume the SDK drops the layout: parameter.
  • The changelog is left to the release.

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

Copy link
Copy Markdown
Contributor Author

Carried into #621, because this change and the v0.0.35 sync fail CI without each other. Closing.

@aicayzer aicayzer closed this Oct 24, 2026
@aicayzer
aicayzer deleted the feat/views-no-layouts branch October 25, 2026 11:43
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