---

name: update-docs description: Review and update documentation after implementation changes. Syncs docs/ and .claude/ with current codebase state. Auto-triggers on "update docs", "sync documentation", "fix docs", "docs out of date", "update the documentation".

Documentation Update Guide

You are helping update RentPath documentation to reflect recent implementation changes.

Arguments

This skill accepts optional arguments to scope the update:

When arguments are provided, focus the review on those specific areas instead of scanning everything.

Before You Start

1. Understand what changed: Review recent code changes or ask the user
2. Identify affected docs: Use the documentation map below
3. Check for discrepancies: Compare code behavior with documented behavior

Documentation Map

Project Documentation (docs/)

Architecture (docs/architecture/)

Modules (docs/modules/)

Patterns (docs/patterns/)

Claude Configuration (.claude/)

Rules (.claude/rules/)

Skills (.claude/skills/)

Agents (.claude/agents/)

Update Process

Step 1: Identify Changed Areas

Copy# See what files changed
git diff --name-only

# See what's staged
git diff --staged --name-only

Map code changes to documentation:

Step 2: Review Documentation

For each affected doc:

1. Read current state - Understand what's documented
2. Compare with code - Identify discrepancies
3. List changes needed:
   • Add new concepts/features
   • Remove deprecated content
   • Fix incorrect information
   • Update examples/code snippets

Step 3: Make Updates

Principles:

• Keep docs concise - remove redundancy
• Use tables for structured information
• Include code examples where helpful
• Cross-reference related docs
• Update the INDEX.md if adding new docs

Common updates:

Copy## Adding a new field

- Update model documentation with field description
- Update validation docs if new rules
- Update wizard docs if wizard field

## Adding a new endpoint

- Update module docs with route
- Update user-flows if changes journey

## Changing architecture

- Update overview.md
- Update relevant pattern docs
- Update .claude/rules if convention changes

Step 4: Verify Consistency

Check for cross-document consistency:

• Field names match between docs and code
• Status values/enums are current
• Route paths are accurate
• Code examples compile/work
• Related docs reference each other correctly

Quick Reference: What to Update When

Output Format

After updating, provide summary:

Copy## Documentation Updates

### Updated Files

- `docs/modules/applications.md` - Added new `visit_notes` field
- `docs/patterns/wizard.md` - Updated step 5 description

### Removed Content

- Removed deprecated `legacy_status` field from applications docs

### Added Content

- New section on visit scheduling workflow

### Cross-Reference Fixes

- Fixed broken link in INDEX.md