Skip to content

docs: document regtype casts, branch staging-env toggle, and Sort & limit merge #11568

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
keydunov wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs: document regtype casts, branch staging-env toggle, and Sort & limit merge #11568

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
58234c6
docs: document regtype casts, branch staging-env toggle, and Sort & l…
claude Aug 16, 2026
82965d5
docs(api-reference): regenerate api.yaml from the enterprise public O…
claude Aug 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion docs-mintlify/admin/deployment/environments.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,11 @@ regardless of user activity.
<img src="https://ucarecdn.com/e0dcce34-a53a-4087-b021-25dbaf730a92/" />
</Frame>

The same toggle is available from the [CLI][ref-cli] (`cube data-model
enable-branch`/`disable-branch`) and the [Platform API][ref-platform-api], so
a shared branch's staging environment can also be kept always active from a
script or CI job.
Comment on lines +55 to +58

@claude claude Bot Aug 16, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The [Platform API][ref-platform-api] link resolves to /api-reference/introduction, but there is no enable/disable-branch endpoint in docs-mintlify/api-reference/api.yaml — the only branch paths there are /build/api/v1/deployments/{deploymentId}/branches (list/create) plus the dev-mode/commit/merge operations. So a reader who follows this link to find "the REST equivalent" mentioned in the PR description won't find it.

Two options, either is fine: name the endpoint inline (POST /build/api/v1/deployments/{deploymentId}/branches/...) so the sentence is self-sufficient, or add the operation to api.yaml next to the sibling branch operations and deep-link it. Leaving a bare link to the API introduction is the one option that doesn't help.

Nit on wording: "The same toggle" reads oddly for a pair of commands — "The same setting can also be changed from …" is closer to what happens.


### Resources and costs

Staging environments run on Shared deployments, incurring [relevant
Expand Down Expand Up @@ -115,4 +120,6 @@ credentials**][ref-credentials].
[ref-overview]: /admin/connect-to-data/visualization-tools
[ref-credentials]: /admin/connect-to-data/visualization-tools
[ref-version]: /admin/deployment#cube-version
[ref-version-channel]: /admin/deployment#update-channels
[ref-version-channel]: /admin/deployment#update-channels
[ref-cli]: /reference/cli
[ref-platform-api]: /api-reference/introduction

@claude claude Bot Aug 16, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: the file still ends without a trailing newline. Since this PR already edits the last line, it's a free fix.

Suggested change
[ref-platform-api]: /api-reference/introduction
[ref-platform-api]: /api-reference/introduction

Loading