Agent skill
refreshing-docs
Refreshes README.md documentation tables including the packages table and core namespace index. Reads from package.json files and core module JSDoc.
Install this agent skill to your Project
npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/documents/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/*/_.tswith JSDoc descriptions
Sections are marked with HTML comments:
<!-- 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
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
Didn't find tool you were looking for?