## Documentation Sync Report ### Signature Changes (from source files) - `docs/api/users.mdx` vs `src/lib/users.ts`: - Documented: `createUser(name, email)` - Source file: `createUser(options: CreateUserInput)` - Action: Update signature and params ### New Exports (in source, not in docs) - `src/lib/auth.ts`: `refreshToken()` - Not documented - `src/lib/users.ts`: `deleteUser()` - Not documented ### Removed (in docs, not in source) - `legacyAuth()` - Not found in any source file ### Up to Date ✓ - `docs/guides/authentication.mdx` matches `src/lib/auth/` ### Unable to Verify (source not found) ⚠️ `docs/legacy/old-api.mdx` - No matching source file ═══════════════════════════════════════════════════════════ FEATURE FLAGS DETECTED ═══════════════════════════════════════════════════════════ ⚠️ src/lib/auth/index.ts:45 - newAuthFlow Current docs: OLD implementation Feature flag: NEW implementation available Question: Update docs to which version? 1. Keep current (old) 2. Update to new (feature-flagged) 3. Document both with toggle notice ═══════════════════════════════════════════════════════════ DUPLICATE FEATURES ═══════════════════════════════════════════════════════════ 🔄 Similar functions found: - src/lib/auth/login.ts → login() - src/lib/auth/v2/authenticate.ts → authenticate() Question: How to handle? 1. Document primary only 2. Document all with comparison 3. Mark duplicates as deprecated

═══════════════════════════════════════════════════════════ CHANGE REVIEW: docs/api/users.mdx ═══════════════════════════════════════════════════════════ 📄 BEFORE (current): ─────────────────────────────────────────────────────────── ## createUser(name, email) Creates a new user account. | Parameter | Type | |-----------|------| | name | string | | email | string | ─────────────────────────────────────────────────────────── 📄 AFTER (proposed): ─────────────────────────────────────────────────────────── ## createUser(options) Creates a new user account. | Parameter | Type | Description | |-----------|------|-------------| | options | CreateUserInput | User creation options | ### CreateUserInput | Property | Type | Required | |----------|------|----------| | name | string | Yes | | email | string | Yes | | role | 'admin' \| 'user' | No | ─────────────────────────────────────────────────────────── ⚠️ NOTICES: - Source: src/lib/users.ts:23 - Feature flag: None - Duplicates: None OPTIONS: 1. ✅ **Approve** - Apply this change 2. ✏️ **Edit** - Modify the proposed content 3. ⏭️ **Skip** - Don't update this file 4. ❌ **Cancel all** - Stop updating Choose an option:

// Before `createUser(name: string, email: string)` // After `createUser(options: CreateUserInput)` Where `CreateUserInput`: ```typescript interface CreateUserInput { name: string; email: string; role?: 'admin' | 'user'; }

--- title: "Webhooks" description: "Receive real-time notifications" --- {/* TODO: Complete this documentation */} ## Overview Documentation coming soon. ## Quick Start ```typescript // Example placeholder

--- ## Key Principles | Principle | Description | |-----------|-------------| | **Search before update** | ALWAYS read source files before changing docs | | **No hallucination** | Only update based on actual file contents | | **Review before write** | ALWAYS show before/after for user approval | | **Flag feature flags** | Detect and highlight conditional features | | **Flag duplicates** | Identify similar/related features | | **Verify changes** | Read source to confirm what changed | ## Quality Guidelines - **SEARCH FIRST** - Read source files before making any update - **REVIEW WITH USER** - Show before/after for each change - **DETECT FEATURE FLAGS** - Search for conditional features - **DETECT DUPLICATES** - Find similar functions/features - Always show changes before applying - Preserve existing prose and explanations - Update only technical details (code, versions, signatures) - Flag when source file not found - offer auto-correct options - Add TODO markers for human review - Apply terminology from context.json - Create stubs rather than skip new features

update-doc

Instructions

Step 0: Read Context

Step 1: Understand What to Update

Step 2: Analyze Current State

For Specific Page:

For Codebase Sync (Search Real Files):

For Navigation:

For Multiple Pages:

For Issues:

Step 3: Detect Feature Flags & Duplicates

Step 4: Generate Sync Report (From File Search)

Step 5: Review Each Change with User (MANDATORY)

Step 6: Apply Updates (After Approval)

Step 6: Update Navigation (if needed)

Step 7: Summary

Update Patterns

Changed Function Signature

New Feature Stub