docs(file-formats): note comma-separated form for claudecode skill paths#1649
docs(file-formats): note comma-separated form for claudecode skill paths#1649Chen17-sq wants to merge 1 commit into
Conversation
Addresses item 3 in dyoshikawa#1618. The claudecode.paths Zod schema accepts z.union([z.string(), z.array(z.string())]), but the file-formats reference only showed the YAML list form. Add a one-sentence callout right after the SKILL.md example that names the comma-separated string form and shows the equivalent value, so the documented surface matches the schema. Doc-only change; skills/rulesync/file-formats.md is regenerated by scripts/sync-skill-docs.ts via the lint-staged hook.
|
Thank you for your contribution! Unfortunately, you currently have 7 open PRs (including this one), which exceeds the limit of 2 for external contributors. Please wait for an existing PR to be reviewed/merged, or close one before opening a new one. See CONTRIBUTING.md for details. |
|
Closing this proactively — the github-actions bot flagged that I'm well over the 2-PR limit for external contributors documented in CONTRIBUTING.md. I opened these nine PRs in one batch without spotting that rule first, which was my mistake — sorry for the noise. The patch in this PR is ready as-is ( Keeping #1643 ( |
Summary
Addresses item 3 from #1618 (review findings for PR #1604, the Claude Code skills
pathsfield).ClaudecodeSkillFrontmatterSchemadeclares:so
pathsaccepts a YAML list or a comma-separated string. Thedocs/reference/file-formats.mdSKILL.md example only showed the list form, leaving the string form undocumented.This PR adds a one-sentence callout immediately after the SKILL.md example that names the comma-separated form and shows the equivalent value:
No code change. No schema change.
skills/rulesync/file-formats.mdis auto-regenerated fromdocs/byscripts/sync-skill-docs.ts(wired throughlint-stagedon everydocs/**/*.mdcommit) and is included in this PR for that reason.Test plan
pnpm cicheck(fmt + oxlint + eslint + tsgo + 5550 vitest + sync-skill-docs check + cspell + secretlint) passes locally on Node 22.docs/reference/file-formats.mdplus the mirrored regeneration inskills/rulesync/file-formats.md.Refs #1618 (item 3 of 6 — the other follow-ups in that issue are out of scope here; item 4 is being addressed separately in #1648).