chore: add config-partials-generator skill#1778
Conversation
Codifies the manual config generation workflow for when the sync-config-schema automation skips alpha releases. Documents source files, generator commands, and the platform generator caveat (PR #1663 must be merged first).
✅ Deploy Preview for vcluster-docs-site ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
@claude review according to best practices of creating skills |
|
Claude finished @Piotr1215's task in 1m 39s —— View job Review: config-partials-generator skillTasks:
SummaryThe skill documents a useful, well-understood workflow and is a solid starting point. There is one critical structural issue and several improvements that would bring it in line with the other skills in this repo. Critical: Missing YAML frontmatterEvery registerable skill in this repo has a YAML frontmatter block. Without it, Claude Code cannot identify or invoke this skill as a slash command. Compare ---
name: vcluster-docs-archiver
description: Archive End-of-Life vCluster documentation versions. Use this skill when creating EOL documentation branches for vCluster or Platform versions. Handles branch creation, Docusaurus configuration, link fixing, Netlify deployment, and main branch updates.
---And ---
name: vcluster-docs-writer
description: Write and edit vCluster Docusaurus documentation. Use this skill when working with .mdx or .md files in the vcluster-docs repository. Handles vale linting, partials discovery, link validation, versioned docs, and release processes.
context: fork
---The new skill needs a frontmatter block like: ---
name: config-partials-generator
description: Generate MDX config reference partials from vCluster JSON schema. Use when automation is skipped for alpha releases or when manually refreshing config docs.
---Improvements1. Hardcoded The path
Recommend adding to Prerequisites: And use 2. Step 3 missing working directory context (line 71) go mod tidy && go mod vendorWhere should this run? The vcluster-docs repo root is implied, but not stated. Compare with 3. PR #1663 reference will become stale (lines 106–112) The conditional "Do NOT run the platform partials generator unless PR #1663 has been merged" is time-sensitive — once merged, this becomes misleading. Options:
4. Workflow doesn't close the loop (after line 130) After Step 5 ("Review output"), the skill stops. Other skills complete the cycle. Add a Step 7 that covers:
5. "Do Not" section style (line 125+) Other skills use What's Working Well
|
add yaml frontmatter for skill registration, replace hardcoded ~/loft/vcluster with <VCLUSTER_REPO> variable, add working directory context to steps 2-3, make pr #1663 guard a runtime check instead of static text, add step 7 for commit/pr workflow, rename "do not" to "never do" for consistency with other skills.
Content Description
Adds a new AI skill that documents the manual config partials generation workflow. The sync-config-schema automation in the vcluster repo skips alpha releases by design, so manual generation is needed during early development phases. This skill codifies the exact steps so future agents can execute it without needing a brief.
Preview Link
N/A — skill file only, no docs content changes.
Internal Reference
References DEVOPS-622
AI review: mention
@claudein a comment to request a review or changes. See CONTRIBUTING.md for available commands.@netlify /docs