feat(docs): emit Mintlify lifecycle metadata and snippet notices for beta/deprecated commands#963
Conversation
|
Claude finished @dangrondahl's task in 2m 22s —— View job Claude PR Review
SummaryClean, well-tested change. The doc generator now emits Mintlify lifecycle front matter ( Static analysis ✅
Both earlier review comments are resolved 👍
Strengths
Minor observations (non-blocking)
Note on draft statusAs the description says, this stays draft until kosli-dev/docs#280 lands — the generated MDX imports Overall this is a solid, reviewable slice that follows the repo's conventions well. ✅ |
- Update snyk.md/artifact.md goldens for the new tag/hidden front matter
and snippet-based deprecation notice (fixes TestDocsCommandTestSuite).
- Escape the deprecation migration message via escapeMintlifyProse so a
future hint containing <, {, or > cannot break the MDX build.
- Skip the beta notice when a command is also deprecated, keeping the body
consistent with lifecycleTag's deprecated-over-beta precedence.
Teaches the CLI doc generator to emit Mintlify lifecycle front matter (
tag: "BETA"/tag: "DEPRECATED",hidden: true) and to render beta/deprecated notices via reusable docs snippets (<CliBetaNotice />,<CliDeprecatedNotice />) instead of inline prose.Adds a
docHiddenannotation so hidden-but-documented commands still get a generated page. Wires theevaluatetree (beta) andattest decision(beta + docHidden) to the real annotations and removes the[BETA]text prefixes. Dedupes the generic deprecation string into one constant and suppresses that boilerplate from generated pages (the snippet conveys it), while preserving real per-command migration hints.The explanatory wording now lives in the docs repo snippets, not in Go.
Draft until kosli-dev/docs#280 lands — the generated MDX imports
/snippets/cli-*-notice.mdx, which only exist after that PR merges. Mark ready for review once #280 is on docsmain.