You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Adds the reusable Mintlify snippets the CLI doc generator imports for beta and deprecated commands (snippets/cli-beta-notice.mdx, snippets/cli-deprecated-notice.mdx).
Updates scripts/update-cli-nav.py so the sidebar pill comes from each page's tag front matter (rendered by Mintlify): the separate "Deprecated" group is removed and hidden: true pages are excluded from navigation (still reachable by direct URL).
Adds a fixture-based test (scripts/test_update_cli_nav.py) verifying hidden pages are skipped, deprecated pages stay in their family group, and no Deprecated group is emitted.
Deploy ordering: merge this first, then release the CLI with the generator changes (kosli-dev/cli companion PR); the release workflow regenerates client_reference/ with the tag/hidden front matter and resolves the snippet imports.
PR Review: CLI lifecycle notice snippets and nav tags
Read changed files and gather context
Review snippet files (.mdx)
Review script changes (update-cli-nav.py)
Review test file (test_update_cli_nav.py)
Post findings
This is a clean, well-scoped PR. The changes are logically consistent: deprecated commands stay in their family group with a sidebar pill instead of being segregated, hidden commands are excluded from nav, and the snippet files are ready for the companion CLI release.
No issues. Both snippets are concise, use the <Warning> component appropriately, and follow the CLAUDE.md rule that snippets should only exist when reused in 2+ pages (these will be imported by the CLI doc generator across many pages).
scripts/update-cli-nav.py
No issues. The refactor cleanly replaces the old deprecated detection (which had a fragile body-text regex fallback) with the simpler hidden front-matter field. The tag front matter is intentionally not read by this script — Mintlify renders it as a sidebar pill automatically. The setdefault simplification and removal of the separate active/deprecated split are nice cleanup.
Suggestion: Minor — the tag field isn't used by this script, but it's mentioned in the docstring and the test fixture. Consider adding a brief comment near get_command_info noting that tag is intentionally ignored (Mintlify handles it). This would help future readers who see tag in the front matter and wonder why the script doesn't read it.
This is entirely optional — the docstring on build_nav_groups already covers it well.
scripts/test_update_cli_nav.py
No issues. The fixture-based test covers the three key behaviors well:
Hidden pages are excluded from navigation
Deprecated pages remain in their family group (not segregated)
No separate "Deprecated" group is emitted
The test exercises the script as a subprocess, which validates the full CLI path including argument parsing.
Suggestion: Consider adding a test case for a beta (non-hidden) page to verify it appears normally in navigation — the current fixture has beta+hidden combined on one page, so the beta-only path isn't exercised independently.
Low priority since the script doesn't treat tag: "BETA" specially (it's a Mintlify concern), but it would document that intent.
Deploy ordering
The PR description correctly notes this should merge before the CLI release. The snippets exist ahead of the pages that will import them, and the nav script is ready to handle the new hidden front matter the CLI generator will produce. No ordering risk.
Overall: Looks good to merge. No critical or blocking issues found.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds the reusable Mintlify snippets the CLI doc generator imports for beta and deprecated commands (
snippets/cli-beta-notice.mdx,snippets/cli-deprecated-notice.mdx).Updates
scripts/update-cli-nav.pyso the sidebar pill comes from each page'stagfront matter (rendered by Mintlify): the separate "Deprecated" group is removed andhidden: truepages are excluded from navigation (still reachable by direct URL).Adds a fixture-based test (
scripts/test_update_cli_nav.py) verifying hidden pages are skipped, deprecated pages stay in their family group, and no Deprecated group is emitted.Deploy ordering: merge this first, then release the CLI with the generator changes (kosli-dev/cli companion PR); the release workflow regenerates
client_reference/with thetag/hiddenfront matter and resolves the snippet imports.