update-docs

Update README.md, CLAUDE.md, and assistant-knowledge.ts after code changes.

90|24|Updated Dec 20, 2025
One-click install
npx skills add https://github.com/knowsuchagency/fulcrum --skill update-docs-knowsuchagency
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/knowsuchagency/fulcrum/tree/main/.claude/skills/update-docs
Command: npx skills add https://github.com/knowsuchagency/fulcrum --skill update-docs-knowsuchagency

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Updating project documentation after code changes is error-prone and time-consuming, leading to out-of-date READMEs, guides, and API references.

Core Features & Use Cases

  • Detects changes across README.md, CLAUDE.md, and assistant-knowledge.ts and updates them accordingly.
  • Prevents accidental updates when the git working tree is dirty to avoid partial docs.
  • Helps maintain consistent documentation across project onboarding and developer guides.

Quick Start

Run the update-docs command to refresh README.md, CLAUDE.md, and assistant-knowledge.ts after committing changes.

Frequently Asked Questions about update-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automatically update documentation files after code changes?

To update documentation after code changes, this Skill detects modifications across your codebase and refreshes files like README.md, CLAUDE.md, and assistant-knowledge.ts to keep project docs synchronized with the latest code.

How do I keep my README in sync with my codebase during CI or local development?

Keeping your README in sync with your codebase is achieved by applying per-file update rules during CI or local development. It enforces pre-flight checks to selectively update file lists and maintain accurate project onboarding guides.

Do I need a clean git status before updating project docs?

Yes, you need a clean git status before updating project docs. The process prevents accidental updates when the git working tree is dirty to avoid generating partial or inconsistent documentation.

What is the best way to maintain consistent documentation across developer guides?

The best way to maintain consistent documentation across developer guides is to automate updates for files like CLAUDE.md and assistant-knowledge.ts after committing changes. This prevents outdated onboarding references and saves time.

Does the documentation update process apply to assistant-knowledge.ts files?

Yes, the documentation update process explicitly applies to assistant-knowledge.ts files across the repository. It enforces selective file lists and explicit pre-flight checks to update them alongside standard markdown docs.