docs(file-formats): align claudecode skill paths/scheduled-task order with code emission#1648
Conversation
… with code emission Addresses item 4 in dyoshikawa#1618. ClaudecodeSkill.toRulesyncSkill emits paths before scheduled-task in its claudecode-section spread (src/features/skills/claudecode-skill.ts lines 128-129), but the file-formats reference documented them in the opposite order. Swap the doc example so the YAML keys appear in the same order users actually see in generated SKILL.md files. Doc-only change; skills/rulesync/file-formats.md is regenerated by the lint-staged sync script.
|
Thank you for your contribution! Unfortunately, you currently have 5 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 4 from #1618 (review findings for PR #1604, the Claude Code skills
pathsfield).ClaudecodeSkill.toRulesyncSkillemits theclaudecodesection in this order:Object spread order determines the YAML key order in serialized output, so generated skill files put
pathsbeforescheduled-task. Butdocs/reference/file-formats.mdhad them swapped (scheduled-taskthenpaths), which made the example diverge from the actual generated output users see in their working tree.This PR moves the
paths:block in the doc example up so the YAML key order matches the spread order in code. No code change, no schema change, no URL 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 4 of 6 — the other follow-ups in that issue are out of scope here).