docs(k8s-proxy-llm-workflow): restore install section — Before you start / Step 1 / Step 2 + copy-block#872
Merged
Conversation
…efore/Step1/Step2) RCA: commit 3b31622 ("trim playbook to verified-working form") removed the three-part install structure from the original 244cd06 page: - "Before you start" prereqs section (PAT + Skills-aware editor) - "Step 1 — Wire up the MCP server" (Claude Code JSON example + link to agent-test-generation for other editors) - "Step 2 — Install the playbook" with: - editor-paths table (Cursor / Claude Code / Windsurf / Antigravity) - "The playbook" sub-section wrapping the FULL skill in a copyable ```markdown code block That trim left readers with the playbook prose but no clear "copy this block" boundary, no MCP wire-up walkthrough, and no editor-paths matrix. A subsequent partial fix (commit 9646579) added a lightweight "## Installation" section but didn't restore the structural copy-block boundary or the editor matrix. This restore: - Re-introduces "Before you start" / Step 1 / Step 2 with the same shape as 244cd06. - Updates the editor-paths matrix to use modern Skills paths: Cursor `.cursor/skills/keploy/SKILL.md` (verified against cursor-agent's built-in `migrate-to-skills` skill — `.cursorrules` is the legacy always-on format being migrated FROM); Claude Code `.claude/skills/keploy/SKILL.md`; Windsurf / Antigravity equivalent. - Wraps the entire playbook (Entry points / Hard rules / Discovery / Routine A / Routine B / Anti-patterns) inside a single ` ````markdown ` fenced code block under "Step 2 → The playbook", with a YAML frontmatter `name: keploy` / `description: …` header so the pasted content is a complete, drop-in SKILL.md. Net effect on the rendered docs page: short install walkthrough at the top, then one big copy-block users paste verbatim into their agent's Skills directory. Linux/macOS install convention is the same; the only per-editor variable is the install path. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
…it together I missed three sections after the playbook code block in the 244cd06 original: 1. The post-block "save the file and fully restart your editor" reminder. 2. **Step 3 — Use the two prompts** with the two-prompt examples and per-routine walkthrough tables (Prompt A phases A0-A5, Prompt B phases B0-B5). 3. **Putting it together** with the six concrete scenario walkthroughs (App regression / Test data drift response edit / Noise / DB query change / Full re-record / Adding tests for a new endpoint). Restored all three, but rewrote the tool-name references against the current skill so the page doesn't drift back to old names: - `get_session_report` → `getTestReportFull` (with `fields=` projection noted) - `update_test_suite` → `updateTestCase` - `update_mock` (MCP) → `keploy mock patch` CLI (since the CLI re-derives `sql_ast_hash` for PostgresV3 mocks — the MCP path writes stale hashes and the matcher misses) - Added `--cluster <name>` + `--disable-mapping=false` + `--disableReportUpload=false` flags everywhere they're now mandatory - Phase A4 now mentions Case 2b's patch-then-recapture order explicitly (delete_recording last, never first) Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Missed the ProductTier badge tag from 244cd06. The original page imported the badge component and rendered it under the H1 to flag that this is an Enterprise (Self-Hosted, Dedicated) feature — a visual cue readers use to confirm they're on the right doc. import ProductTier from '@site/src/components/ProductTier'; <ProductTier tiers="Enterprise" offerings="Self-Hosted, Dedicated" /> Other quickstart pages in version-4.0.0/ use the same pattern; adding it back keeps this page consistent with the rest. (Skipped the `useBaseUrl` import from 244cd06 — the current page has no images to resolve paths for, so importing it would just trip the no-unused-vars lint on MDX.) Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
charankamarapu
force-pushed
the
docs/restore-skill-install-section
branch
from
482c19c to
a6d8b02
Compare
gouravkrosx
approved these changes
Jun 7, 2026
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
Restores the three-part install structure on the LLM-workflow docs page that was lost in the May trim (commit 3b31622). Readers landing on the page now get a clear walkthrough — prereqs → MCP wire-up → editor-paths matrix → one copyable code-block containing the full skill.
RCA
The original page (commit 244cd06, #…) had:
```markdownblock (withname:/description:YAML frontmatter at the top so the pasted content is a drop-in SKILL.md).Commit 3b31622 ("trim playbook to verified-working form") removed all three sections, leaving only the playbook prose. A subsequent partial fix (commit 9646579 on PR #871) added a lightweight
## Installationsection back but didn't restore the structural copy-block boundary, the editor matrix, or the "Before you start" prereqs.A user (Globality / Joel) hit exactly this — they fell back to following the older
agent-test-generation.md"Create a.cursorrulesfile" instruction because this page no longer told them where to put the skill content.What this PR does
.cursor/skills/keploy/SKILL.md(verified against cursor-agent's built-inmigrate-to-skillsskill —.cursorrulesis the deprecated always-on format being migrated FROM)..claude/skills/keploy/SKILL.md(or~/.claude/skills/keploy/SKILL.mdglobal).skills/<name>/SKILL.md.````markdownfenced code block under "Step 2 → The playbook", withname: keploy+description: …YAML frontmatter so the pasted content is a complete drop-in SKILL.md.Test plan
vale --config=.vale.ini versioned_docs/version-4.0.0/quickstart/k8s-proxy-llm-workflow.md→ 0 errors / 0 warnings.prettier --check→ clean.````markdown, 1 closing````(each appears once).yarn start) and confirm the copy button works on the Step 2 code block (will check before merging).🤖 Generated with Claude Code