Sync kane cli docs from testmuCom (MDX format) - #3485
Open
surishubham wants to merge 1 commit into
Open
Conversation
Port the testmuCom "docs(kane-cli): sync public docs with the GitHub user guide" update (PR #3479) into the Mintlify docs set, converted from Docusaurus Markdown to MDX. New pages: - kane-cli-testmd-composition — composing tests with @import - kane-cli-testmd-running — running and replaying test.md files - kane-cli-testrun — batch runs with testrun - kane-cli-troubleshooting-sharp — sharp install failure deep dive Updated pages (new sections/flags/tables carried over from testmuCom): - kane-cli-assurance-automation — ingest/reconcile automation rules, expanded NDJSON event vocabulary, coverage-on-the-stream, release mismatch handling - kane-cli-assurance-context — brought fully current with the Requirement Sources (remote URL ingestion) content, plus 0.7.1 structured answer/verdict flags - kane-cli-assurance-coverage — the cover gaps coverage ribbon and per-use-case dossier (0.8.2) - kane-cli-assurance-design — --phase, --allow-unreviewed, --answer, citation verification - kane-cli-assurance-maintain — full remote-sources reconcile support, held-source guard, in-chat review cards (0.7.2) - kane-cli-configuration — default start URL, bug detection, project/ folder auto-default and self-healing, Chrome env vars - kane-cli-installation — pnpm/yarn support notes, verify output, Linux arm64 - kane-cli-modes — run options reference, mobile runs - kane-cli-testmd — url/tags/session_context frontmatter keys, step body shapes, variables & context sections - kane-cli-tms-integration — evidence pack publishing, projects/folders CLI, auto-default on first run - kane-cli-troubleshooting — TLS/proxy login failures, exit-code-2 diagnosis, evidence-pack debugging, testrun preflight failures - kane-cli-variables-and-context — syntax field, variables file shape Also adds navigation entries for the four new pages to docs.json. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CHzW1bQvwFsATEnM6qeaLh
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Syncs the Kane CLI docs on
stage-mintlifywith the latest content merged intotestmuCom(PR #3479, "docs(kane-cli): sync public docs with the GitHub user guide"), converting each Docusaurus Markdown source to Mintlify MDX.New pages
docs/kane-cli-testmd-composition.mdx— composing tests with@importdocs/kane-cli-testmd-running.mdx— running and replayingtest.mdfilesdocs/kane-cli-testrun.mdx— batch runs withtestrundocs/kane-cli-troubleshooting-sharp.mdx—sharpinstall failure deep diveAll four are wired into
docs.jsonnavigation (a new "Test.md" subgroup under Core Concepts, and a new "Troubleshooting" subgroup under Reference, mirroring testmuCom'ssidebars.js).Updated pages
kane-cli-assurance-automation— ingest/reconcile automation rules, an expanded NDJSON event vocabulary, coverage-on-the-stream, release-mismatch handlingkane-cli-assurance-context— brought fully current with Requirement Sources (remote URL ingestion), plus 0.7.1 structured answer/verdict flags (this page had drifted further behind than the rest, so it got a full content resync rather than an incremental patch)kane-cli-assurance-coverage— thecover gapscoverage ribbon and per-use-case dossier (0.8.2)kane-cli-assurance-design—--phase,--allow-unreviewed,--answer, citation verificationkane-cli-assurance-maintain— full remote-sources reconcile support, held-source guard, in-chat review cards (0.7.2) — also fully resynced for the same reason asassurance-contextkane-cli-configuration— default start URL, bug detection, project/folder auto-default and self-healing, Chrome env varskane-cli-installation— pnpm/yarn support notes, verify output, Linux arm64kane-cli-modes— run options reference, mobile runskane-cli-testmd—url/tags/session_contextfrontmatter keys, step body shapes, Variables & Context sectionskane-cli-tms-integration— evidence pack publishing, projects/folders CLI, auto-default on first runkane-cli-troubleshooting— TLS/proxy login failures, exit-code-2 diagnosis, evidence-pack debugging, testrun preflight failureskane-cli-variables-and-context—syntaxfield, variables-file shapeConversion notes
:::note/:::tip/:::warning→ Mintlify<Note>/<Tip>/<Warning>/support/docs/...to/docs/...title,sidebarTitle,description,keywords,og:description) used instead🤖 Generated with Claude Code
https://claude.ai/code/session_01CHzW1bQvwFsATEnM6qeaLh
Generated by Claude Code