Skip to content

docs: enhance hierarchy documentation in Explore and Workbooks#11074

Open
solarrust wants to merge 2 commits into
masterfrom
alena/cub-2868-document-hierarchy-support-in-explore
Open

docs: enhance hierarchy documentation in Explore and Workbooks#11074
solarrust wants to merge 2 commits into
masterfrom
alena/cub-2868-document-hierarchy-support-in-explore

Conversation

@solarrust

Copy link
Copy Markdown
Collaborator

Added details on how hierarchies are displayed and utilized within the Explore and Workbooks sections. Updated references to include exploration capabilities and clarified the functionality of hierarchies in the context of querying data. Improved cross-references to related documentation for better navigation.

Added details on how hierarchies are displayed and utilized within the Explore and Workbooks sections. Updated references to include exploration capabilities and clarified the functionality of hierarchies in the context of querying data. Improved cross-references to related documentation for better navigation.
@solarrust solarrust requested a review from igorlukanin June 12, 2026 16:19
@solarrust solarrust requested a review from keydunov as a code owner June 12, 2026 16:19
@github-actions github-actions Bot added the pr:community Contribution from Cube.js community members. label Jun 12, 2026
@claude

claude Bot commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Claude finished @solarrust's task in 2m 10s —— View job


Code Review

Verdict: LGTM — clean, accurate docs change. No blocking issues.

Details (0 high, 0 medium, 2 low / nits)

Checklist

  • Read the diff (git show fcb1725)
  • Verified new internal links resolve (hierarchies.mdx, view#folders, explore.mdx, querying-data#hierarchies)
  • Reviewed prose for clarity and consistency with existing docs

What this PR does well

  • The new Hierarchies section in workbooks/querying-data.mdx is concrete and well-scoped: it explains visual appearance, level ordering, folder nesting, search behavior, and used‑members view.
  • Cross‑references are bidirectional: explore.mdxquerying-data.mdxhierarchies.mdx, so readers landing on any of the three find the others.
  • The APIs‑support table in reference/core-data-apis/index.mdx is now consistent with reality (Explore + Workbooks added alongside Playground).
  • All newly introduced reference‑style link IDs resolve to existing files/anchors (verified view#folders at docs-mintlify/reference/data-modeling/view.mdx:497).

Nits (non‑blocking)

1. Link style inconsistency in explore.mdxdocs-mintlify/docs/explore-analyze/explore.mdx:46-49

The new paragraph mixes a reference-style link ([hierarchies][ref-hierarchies]) with an inline-URL link to the workbooks anchor:

they appear in the members panel the same way they do in
[workbooks](/docs/explore-analyze/workbooks/querying-data#hierarchies) — expand a

For consistency with the rest of the file (which uses the reference style), consider defining [ref-workbooks-hierarchies]: /docs/explore-analyze/workbooks/querying-data#hierarchies at the bottom and using [workbooks][ref-workbooks-hierarchies]. Purely cosmetic.

2. Trailing newline missingdocs-mintlify/reference/core-data-apis/index.mdx

Diff shows \ No newline at end of file. Pre‑existing (the \ No newline marker appears on the unchanged end), but worth fixing while touching the file.

Out of scope (pre‑existing, not introduced here)

  • [ref-playground]: /admin/workspace/playground in core-data-apis/index.mdx:97 and [ref-playground]: /docs/workspace/playground#viewing-the-data-model in hierarchies.mdx:329 both resolve to paths that don't exist under docs-mintlify/. Not introduced by this PR — flagging only for awareness.
· `alena/cub-2868-document-hierarchy-support-in-explore`

@claude

claude Bot commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Claude finished @solarrust's task in 43s —— View job


Code Review

Docs-only PR adding hierarchy guidance across Explore, Workbooks, and the data-modeling reference. Verdict: LGTM — 0 high, 0 medium, 1 low.

Details
  • Read diff and changed files
  • Verify cross-reference targets and anchors
  • Check Mintlify conventions

What's good

  • New ## Hierarchies section in querying-data.mdx is well-structured (bold lead-ins, examples, search/used-members notes) and is correctly linked from the intro paragraph (#hierarchies).
  • The reciprocal links across explore.mdx, querying-data.mdx, hierarchies.mdx, and core-data-apis/index.mdx are consistent — references to /reference/data-modeling/hierarchies, /reference/data-modeling/view#folders, and /docs/explore-analyze/workbooks/querying-data#hierarchies all resolve to real targets/anchors.
  • Capitalization of "Explore" / "workbooks" / "Playground" matches existing usage in hierarchies.mdx.
  • Trailing-newline fix in hierarchies.mdx is a nice cleanup.

Low — minor

  • docs-mintlify/reference/core-data-apis/index.mdx:99[ref-workbooks]: /analytics/workbooks is a pre-existing link that does not match the canonical /docs/explore-analyze/workbooks/... path used elsewhere in this PR. Not introduced here, so out of scope, but worth aligning in a follow-up since this file now has both ref-explore (pointing into /docs/...) and ref-workbooks (pointing into /analytics/...) referenced from the same table row.
  • docs-mintlify/reference/core-data-apis/index.mdx is missing a trailing newline (same as before this PR — flagged only because hierarchies.mdx got fixed in this PR; would be nice to do both).

No security, performance, or testing concerns — pure docs change.

• Branch: `alena/cub-2868-document-hierarchy-support-in-explore`

@mintlify

mintlify Bot commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
cubed3 🟢 Ready View Preview Jun 12, 2026, 4:38 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pr:community Contribution from Cube.js community members.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant