my_docs

Documentation Update Command

Update documentation for all uncommitted code changes. Handles inline docs (PHPDoc, JSDoc, DartDoc) and project documentation in /docs folder.

Arguments

Parse from $ARGUMENTS:

• --inline-only: Only update inline docblocks, skip /docs folder
• --folder-only: Only update /docs folder, skip inline docs
• --check-only: Report what needs updating without making changes

Default (no args): Update both inline docs and /docs folder.

Execution Steps

Step 1: Identify Changes

# Get changed files
git diff --name-only HEAD

# Filter to code files only
# Exclude: configs, package files, assets, tests

Step 2: Detect Documentation Style

For each file type, detect existing style:

# PHP: Check for PHPDoc
grep -l "@param\|@return" *.php

# JS/TS: Check for JSDoc/TSDoc
grep -l "@param\|@returns" *.js *.ts

# Dart: Check for DartDoc
grep -l "^///" *.dart

# Vue: Check component docs
grep -l "@prop\|defineProps" *.vue

Step 3: Launch Doc Updater Agent

Use the Task tool to run doc-updater:

Task({
  subagent_type: "doc-updater",
  prompt: `Update documentation for uncommitted changes.
           Changed files: ${CHANGED_FILES}
           Mode: ${MODE}  // inline-only, folder-only, or both

           For each file:
           1. Detect existing doc style
           2. Find undocumented or outdated docs
           3. Add/update documentation

           Project has /docs folder: ${HAS_DOCS_FOLDER}`
})

Step 4: Process Results

The agent will return a list of changes made:

Category	Action
New docblocks	Added
Outdated docs	Updated
/docs files	Modified

Step 5: Check-Only Mode

If --check-only, present report without changes:

# Documentation Audit

## Missing Documentation

### Inline Docs Needed
| File | Item | Type |
|------|------|------|
| `OrderService.php:45` | `calculateTotal()` | Method |
| `order_card.dart:23` | `OrderCard` | Class |

### Outdated Documentation
| File | Item | Issue |
|------|------|-------|
| `UserController.php:78` | `update()` | Missing @throws |

### /docs Updates Needed
| Doc File | Reason |
|----------|--------|
| `docs/api/orders.md` | New endpoint added |