Docs Tsdoc Readme

Document public APIs using README, TSDoc, and OpenSpec specs Use when this capability is needed.

tomevault-io Updated

File contents

Documentation

What to update

  • openspec/specs/ for behavior
  • README for usage
  • TSDoc for exported functions/classes

Rule

Document the "why" for non-obvious decisions.


Converted and distributed by TomeVault — claim your Tome and manage your conversions.

tomevault-io/skills-registry/tree/main/saikus08--opencode-workbench--docs-tsdoc-readme commit 35bd5072dd

Frequently asked questions

npx skillmds@latest add tomevault-io/docs-tsdoc-readme