Claude Code docs-and-examples for TypeScript package quick starts
Use real exports, invocation, and runtime requirements to write a README, quick start or migration note.
中文Install in Claude Code
Have the package’s public exports, installation method, runtime version and test environment available as evidence for Claude Code.
- Review `.claude/skills/docs-and-examples/SKILL.md` and its requirements at the pinned GitHub commit.
- Create `.claude/skills/docs-and-examples/` in your project and save the reviewed file as `.claude/skills/docs-and-examples/SKILL.md`.
- Start Claude Code from that project's root, then select `/docs-and-examples` in the slash menu.
Example task
In package-19, the published function formatLabel(value) returns “Office chair” for “office chair”. The prior README calls formatTitle(), which is not exported.What to check
Revise the quick start to demonstrate {api: 'formatLabel', input: 'office chair', output: 'Office chair'}. Record only examples actually run.
Original SKILL.md on GitHub · Updated
Frequently asked question
What if the API in an example does not appear in the exports?
Check the release’s public exports and module entry point. Update the call to the verified form and explain any migration differences that users must handle.