sync-docs

Update and maintain project documentation for CLAUDE.md and README.md:

Safety Notice

This listing is imported from skills.sh public index metadata. Review upstream SKILL.md and repository scripts before running.

Copy this and send it to your AI assistant to learn

Install skill "sync-docs" with this command: npx skills add tartinerlabs/skills/tartinerlabs-skills-sync-docs

Update and maintain project documentation for CLAUDE.md and README.md:

  1. CLAUDE.md Management

Purpose: Keep Claude's project instructions current and accurate

  • Scan project structure: Check for new tools, scripts, build systems

  • Update build commands: Sync with package.json, Makefile, or build configs

  • Add new patterns: Document coding conventions, file organization

  • Refresh tool commands: Update linting, testing, deployment instructions

  • Check environment setup: Verify installation and setup steps

  1. README.md Maintenance

Purpose: Keep public project documentation up-to-date

  • Update installation: Check dependencies, requirements, setup steps

  • Refresh usage examples: Verify code samples and API documentation

  • Validate links: Test external links, badges, and references

  • Update project status: Current features, roadmap, version info

  • Check screenshots/demos: Ensure visual examples are current

  1. Smart Detection Process
  • File existence: Create CLAUDE.md or README.md if missing

  • Project analysis: Scan codebase for changes since last update

  • Cross-reference: Compare project structure with documented instructions

  • Outdated sections: Identify stale information automatically

  • Consistency check: Ensure both files complement each other

  1. Validation Steps
  • Run project commands mentioned in docs to verify they work

  • Test installation steps from scratch perspective

  • Validate all external links and references

  • Check that CLAUDE.md instructions match current project setup

  • Ensure README.md accurately represents current project state

Focus on keeping both files synchronized with the actual project state and useful for their respective audiences: Claude for CLAUDE.md, users/developers for README.md.

Source Transparency

This detail page is rendered from real SKILL.md content. Trust labels are metadata-based hints, not a safety guarantee.

Related Skills

Related by shared tags or category signals.

General

project-structure

No summary provided by upstream source.

Repository SourceNeeds Review
General

tailwind

No summary provided by upstream source.

Repository SourceNeeds Review
General

commit

No summary provided by upstream source.

Repository SourceNeeds Review