Skip to content

Sync kane cli docs from testmuCom (MDX format) - #3484

Open
surishubham wants to merge 3 commits into
stage-mintlifyfrom
claude/adoring-feynman-kgwq2v
Open

Sync kane cli docs from testmuCom (MDX format)#3484
surishubham wants to merge 3 commits into
stage-mintlifyfrom
claude/adoring-feynman-kgwq2v

Conversation

@surishubham

Copy link
Copy Markdown
Collaborator

What

Syncs the Kane CLI doc updates from testmuCom PR #3479 ("docs(kane-cli): sync public docs with the GitHub user guide", merged into testmuCom as 76e5474d) into stage-mintlify, converted from Docusaurus Markdown to Mintlify MDX.

That upstream PR brought the public Kane CLI docs into parity with LambdaTest/kane-cli's docs/user-guide (the source of truth): four new pages, and twelve pages that gained sections previously missing from the docs site.

New pages

Page Content
docs/kane-cli-testrun.mdx kane-cli testrun run — batch runs, tag/regex selection, parallel workers, dry runs, exit codes, one sealed evidence pack per suite
docs/kane-cli-testmd-composition.mdx @import syntax, path resolution, optional imports, what propagates, sharing helpers across projects
docs/kane-cli-testmd-running.mdx Full kane-cli testmd flag reference, replay vs author, the cascade rule, lock conflicts, list/status/delete/export/sync
docs/kane-cli-troubleshooting-sharp.mdx The three causes of a sharp install failure, the fix for each, what still works without it

Updated pages (new sections merged in, nothing removed)

kane-cli-testmd, kane-cli-troubleshooting, kane-cli-assurance-automation, kane-cli-configuration, kane-cli-modes, kane-cli-tms-integration, kane-cli-assurance-coverage, kane-cli-assurance-context, kane-cli-assurance-maintain, kane-cli-installation, kane-cli-assurance-design, kane-cli-variables-and-context — each additively merged against its current Mintlify version by diffing the old and new Docusaurus source, so only genuinely new prose/sections/table rows were inserted, at their equivalent location.

Navigation (docs.json)

  • Core Concepts: Test.md is now a group (kane-cli-testmd, kane-cli-testmd-composition, kane-cli-testmd-running), followed by kane-cli-testrun — mirroring the sidebars.js restructure on testmuCom.
  • Reference: Troubleshooting is now a group (kane-cli-troubleshooting, kane-cli-troubleshooting-sharp).

Conversion notes

Followed the established MDX conventions already used across the kane-cli-*.mdx pages on this branch:

  • Frontmatter trimmed to title / sidebarTitle / description / keywords (array) / og:description; dropped Docusaurus-only fields (id, url, site_name, slug, canonical).
  • Dropped <script type="application/ld+json"> breadcrumb blocks; added the AgentSkillCallout import/usage to new pages.
  • :::note<Note>, :::warning<Warning>, :::tip<Tip>.
  • Internal links rewritten from /support/docs/<slug>/ to /docs/<slug>/.

No content was paraphrased or dropped — verified no leftover /support/docs/ links or ::: admonition syntax remain, and docs.json parses as valid JSON.


🤖 Generated with Claude Code

https://claude.ai/code/session_01WajQp3gGPGEqW5GA59RoSU


Generated by Claude Code

Ports the kane-cli doc updates merged into testmuCom via PR #3479
("sync public docs with the GitHub user guide") into Mintlify MDX on
stage-mintlify. This is an in-progress commit; more files land in
follow-up commits as the conversion completes.

So far:
- New: docs/kane-cli-testrun.mdx
- Updated: kane-cli-assurance-automation, kane-cli-configuration,
  kane-cli-testmd, kane-cli-tms-integration (new sections merged in)
- docs.json: nav entries for kane-cli-testrun and the upcoming
  kane-cli-testmd-composition / kane-cli-testmd-running /
  kane-cli-troubleshooting-sharp pages

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WajQp3gGPGEqW5GA59RoSU
Continues porting PR #3479's testmuCom additions into Mintlify MDX.

So far in this batch:
- New: docs/kane-cli-troubleshooting-sharp.mdx
- Updated: kane-cli-assurance-automation, kane-cli-assurance-context,
  kane-cli-assurance-coverage, kane-cli-assurance-design,
  kane-cli-assurance-maintain, kane-cli-installation, kane-cli-modes,
  kane-cli-testmd, kane-cli-troubleshooting, kane-cli-variables-and-context

Still pending: kane-cli-testmd-composition.mdx, kane-cli-testmd-running.mdx

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WajQp3gGPGEqW5GA59RoSU
Completes porting PR #3479's testmuCom additions into Mintlify MDX:
- New: docs/kane-cli-testmd-running.mdx
- Updated: kane-cli-assurance-context, kane-cli-assurance-coverage,
  kane-cli-assurance-design, kane-cli-assurance-maintain (new sections
  merged in, existing content preserved)

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WajQp3gGPGEqW5GA59RoSU
@mintlify

mintlify Bot commented Sep 4, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated
lambdatest-f4bdd228 🟢 Ready View Preview Sep 4, 2026, 8:53 AM

💡 Tip: Enable Automations 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

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants