docs: add view groups documentation#10808
Conversation
Add documentation for the view_group feature introduced in v1.6.43: - New reference page: reference/data-modeling/view-group.mdx Covers name, title, description, and views parameters with YAML and JavaScript examples using the ecommerce data model. - View reference: add view_group and view_groups parameters Documents both singular and plural forms for assigning views to groups. - Conceptual views page: add 'Grouping views with view groups' section with a full example showing both group-level and view-level assignment. - Syntax page: mention view_groups in folder structure example. - Navigation: add view-group page to Reference > Data Modeling. Co-authored-by: Pavel Tiunov <pavel.tiunov@gmail.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Claude finished @paveltiunov's task in 3m 14s —— View job Review: View Groups Documentation
This is a well-structured documentation PR. The new content is clear, well-organized, and follows the existing doc conventions. A few observations: What looks good
Nits (non-blocking)
SummaryClean, comprehensive docs addition that covers the feature from both conceptual and reference angles. The examples are practical and the cross-linking is solid. The nits above are all minor wording/style suggestions — nothing blocking. |
| ### `view_group` | ||
|
|
There was a problem hiding this comment.
Nit: The phrasing "must be defined with view_group()" is JavaScript-specific. YAML users would define it with the view_groups: block, not a function call. Consider something syntax-neutral like:
| ### `view_group` | |
| Assigns this view to a single [view group][ref-ref-view-group]. The referenced | |
| view group must be defined elsewhere in the data model. |
| [ref-dim-format]: /reference/data-modeling/dimensions#format | ||
| [ref-dim-meta]: /reference/data-modeling/dimensions#meta No newline at end of file | ||
| [ref-dim-meta]: /reference/data-modeling/dimensions#meta | ||
| [ref-ref-view-group]: /reference/data-modeling/view-group No newline at end of file |
There was a problem hiding this comment.
Nit: file should end with a newline.
| [ref-ref-view-group]: /reference/data-modeling/view-group | |
| [ref-ref-view-group]: /reference/data-modeling/view-group |
| </CodeGroup> | ||
|
|
||
| ### `view_group` | ||
|
|
There was a problem hiding this comment.
Nit: The phrasing "must be defined with view_group()" is JavaScript-specific. YAML users would define it with the view_groups: block, not a function call. Consider something syntax-neutral like "must be defined elsewhere in the data model."
|
|
||
| Assigns this view to multiple [view groups][ref-ref-view-group] at once. | ||
| Each referenced view group must be defined with `view_group()` elsewhere | ||
| in the data model. |
There was a problem hiding this comment.
Same note as the view_group section — "defined with view_group()" is JS-specific syntax. Consider "must be defined elsewhere in the data model" for syntax neutrality.
| [ref-dim-description]: /reference/data-modeling/dimensions#description | ||
| [ref-dim-format]: /reference/data-modeling/dimensions#format | ||
| [ref-dim-meta]: /reference/data-modeling/dimensions#meta No newline at end of file | ||
| [ref-dim-meta]: /reference/data-modeling/dimensions#meta |
There was a problem hiding this comment.
Nit: File should end with a trailing newline.
Check List
Description of Changes Made
Adds documentation for the
view_groupfeature introduced in v1.6.43 (#10768). View groups let data model authors organize views into named collections by domain or purpose (e.g.,sales,finance,people), making it easier for downstream consumers — AI agents, embedded analytics, and visualization tools — to discover the right dataset.Changes
New reference page (
reference/data-modeling/view-group.mdx)name,title,description,viewsviewslist vs. view-levelview_group/view_groupsproperties)/v1/metaresponseView reference page (
reference/data-modeling/view.mdx)view_group(singular) andview_groups(plural) parameter sections with YAML and JavaScript examplesConceptual views page (
docs/data-modeling/views.mdx)Syntax page (
docs/data-modeling/concepts/syntax.mdx)view_groups.ymlNavigation (
docs.json)reference/data-modeling/view-groupto Reference > Data Modeling, right after the view page