refreshing-docs

Refreshes README.md documentation tables including the packages table and core namespace index. Reads from package.json files and core module JSDoc.

Stars 163

Forks 31

Install this agent skill to your Project

npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/data/refreshing-docs

SKILL.md

Refreshing Docs

Update auto-generated documentation tables in README.md.

Steps

Run the script at .claude/skills/refreshing-docs/scripts/docs-refresh.ts

Reference

The script updates two sections in README.md:

Packages table - Lists all packages from packages/*/package.json
Core namespace index - Lists modules from core/src/*/_.ts with JSDoc descriptions

Sections are marked with HTML comments:

markdown

<!-- PACKAGES_TABLE_START -->
| Package | Description |
| ------- | ----------- |
| [`@kitz/core`](./packages/core) | Core utilities |
...
<!-- PACKAGES_TABLE_END -->

<!-- CORE_NAMESPACE_INDEX_START -->
| Module | Description |
| ------ | ----------- |
| `Arr` | Array utilities |
...
<!-- CORE_NAMESPACE_INDEX_END -->

Notes

Run after adding/removing packages or modifying package descriptions
Run after adding/modifying core modules or their JSDoc
The markers must exist in README.md for the script to work