Update Docs

Sync documentation from source-of-truth (package.json, .env.example). Generates CONTRIB.md, RUNBOOK.md. Use when updating project docs or after adding scripts/env vars.

ihj04982 Updated

File contents

Update Documentation

Sync documentation from source-of-truth:

  1. Read package.json scripts section

    • Generate scripts reference table
    • Include descriptions from comments
  2. Read .env.example

    • Extract all environment variables
    • Document purpose and format
  3. Generate docs/CONTRIB.md with:

    • Development workflow
    • Available scripts
    • Environment setup
    • Testing procedures
  4. Generate docs/RUNBOOK.md with:

    • Deployment procedures
    • Monitoring and alerts
    • Common issues and fixes
    • Rollback procedures
  5. Identify obsolete documentation:

    • Find docs not modified in 90+ days
    • List for manual review
  6. Show diff summary

Single source of truth: package.json and .env.example

ihj04982/my-cursor-settings/tree/main/skills/update-docs commit a7c98d045f

Frequently asked questions

npx skillmds@latest add ihj04982/update-docs