cmp-standards 2.7.0 → 2.8.0-alpha

package/templates/workflows/sync-docs.md

@@ -1,187 +1,187 @@
----
-description: "/sync - Synchronize and validate all project documentation automatically"
----
-
-# Documentation Sync Workflow
-
-This workflow executes all documentation validations and updates.
-
-## Overview
-
-The `/sync` command ensures all project documentation is:
-- Up to date with code changes
-- Consistent across files
-- Following established patterns
-- Properly validated
-
-## Execution Steps
-
-### 1. Health Check
-
-Run documentation health check:
-```bash
-npm run docs:health
-# Or custom command for your project
-```
-
-Verifies:
-- All required docs exist
-- No broken internal links
-- Timestamps are recent
-
-### 2. Schema Documentation
-
-Generate schema documentation:
-```bash
-npm run docs:schema
-# Or: npx drizzle-kit generate
-```
-
-Updates:
-- Database schema docs
-- Type definitions
-- API documentation
-
-### 3. AI Context Sync
-
-Sync AI context files:
-```bash
-cmp-memory sync
-```
-
-Updates:
-- CLAUDE.md with latest project state
-- Skills registry
-- Agent configurations
-
-### 4. Translation Check
-
-Verify translations (if applicable):
-```bash
-npm run i18n:check
-```
-
-Checks:
-- Missing translation keys
-- Inconsistent translations
-- Unused keys
-
-### 5. Finance Sync (if applicable)
-
-Verify finance-ledger synchronization:
-```bash
-npm run lint:finance-sync
-```
-
-Ensures:
-- All finance operations have ledger entries
-- Cash flow integrity maintained
-
-### 6. Lint Report
-
-Generate intelligent lint report:
-```bash
-npm run lint:report
-# Or: npx eslint . --format json > .lint/report.json
-```
-
-Produces:
-- Categorized issues
-- Priority ranking
-- Fix suggestions
-
-## Full Report
-
-The sync produces a comprehensive report:
-
-```
-Documentation Sync Report
-========================
-
-Health Check:
-  - CLAUDE.md: OK (updated 2h ago)
-  - README.md: OK
-  - API docs: STALE (updated 7d ago) <-- Action needed
-
-Schema:
-  - 47 tables documented
-  - 3 new columns since last sync
-  - Types: up to date
-
-AI Context:
-  - 12 agents configured
-  - 8 skills registered
-  - Hooks: synchronized
-
-Translations:
-  - en: 100% (847/847)
-  - es: 98% (834/847) <-- 13 missing
-  - de: 95% (805/847) <-- 42 missing
-
-Lint Summary:
-  - Errors: 0
-  - Warnings: 12
-  - Info: 45
-
-Overall: NEEDS_ATTENTION
-Action Items:
-  1. Update API documentation
-  2. Add 13 Spanish translations
-  3. Review 12 lint warnings
-```
-
-## Automation
-
-### Pre-commit Hook
-
-Add to `.claude/hooks/pre-commit.sh`:
-```bash
-#!/bin/bash
-cmp-memory sync --quick
-if [ $? -ne 0 ]; then
-  echo "Documentation sync failed"
-  exit 1
-fi
-```
-
-### CI Integration
-
-```yaml
-- name: Documentation Sync
-  run: |
-    cmp-memory sync
-    git diff --exit-code docs/
-```
-
-## Customization
-
-Configure in `project.config.json`:
-
-```json
-{
-  "sync": {
-    "healthCheck": true,
-    "schemaDoc": true,
-    "aiContext": true,
-    "i18n": false,
-    "financeSync": false,
-    "lintReport": true
-  }
-}
-```
-
-## When to Run
-
-### Automatic Triggers
-- Pre-commit (quick mode)
-- PR creation
-- Release preparation
-
-### Manual Triggers
-- After major refactors
-- Before important demos
-- Monthly maintenance
-
----
-
-**Status**: Production Ready
+---
+description: "/sync - Synchronize and validate all project documentation automatically"
+---
+
+# Documentation Sync Workflow
+
+This workflow executes all documentation validations and updates.
+
+## Overview
+
+The `/sync` command ensures all project documentation is:
+- Up to date with code changes
+- Consistent across files
+- Following established patterns
+- Properly validated
+
+## Execution Steps
+
+### 1. Health Check
+
+Run documentation health check:
+```bash
+npm run docs:health
+# Or custom command for your project
+```
+
+Verifies:
+- All required docs exist
+- No broken internal links
+- Timestamps are recent
+
+### 2. Schema Documentation
+
+Generate schema documentation:
+```bash
+npm run docs:schema
+# Or: npx drizzle-kit generate
+```
+
+Updates:
+- Database schema docs
+- Type definitions
+- API documentation
+
+### 3. AI Context Sync
+
+Sync AI context files:
+```bash
+cmp-memory sync
+```
+
+Updates:
+- CLAUDE.md with latest project state
+- Skills registry
+- Agent configurations
+
+### 4. Translation Check
+
+Verify translations (if applicable):
+```bash
+npm run i18n:check
+```
+
+Checks:
+- Missing translation keys
+- Inconsistent translations
+- Unused keys
+
+### 5. Finance Sync (if applicable)
+
+Verify finance-ledger synchronization:
+```bash
+npm run lint:finance-sync
+```
+
+Ensures:
+- All finance operations have ledger entries
+- Cash flow integrity maintained
+
+### 6. Lint Report
+
+Generate intelligent lint report:
+```bash
+npm run lint:report
+# Or: npx eslint . --format json > .lint/report.json
+```
+
+Produces:
+- Categorized issues
+- Priority ranking
+- Fix suggestions
+
+## Full Report
+
+The sync produces a comprehensive report:
+
+```
+Documentation Sync Report
+========================
+
+Health Check:
+  - CLAUDE.md: OK (updated 2h ago)
+  - README.md: OK
+  - API docs: STALE (updated 7d ago) <-- Action needed
+
+Schema:
+  - 47 tables documented
+  - 3 new columns since last sync
+  - Types: up to date
+
+AI Context:
+  - 12 agents configured
+  - 8 skills registered
+  - Hooks: synchronized
+
+Translations:
+  - en: 100% (847/847)
+  - es: 98% (834/847) <-- 13 missing
+  - de: 95% (805/847) <-- 42 missing
+
+Lint Summary:
+  - Errors: 0
+  - Warnings: 12
+  - Info: 45
+
+Overall: NEEDS_ATTENTION
+Action Items:
+  1. Update API documentation
+  2. Add 13 Spanish translations
+  3. Review 12 lint warnings
+```
+
+## Automation
+
+### Pre-commit Hook
+
+Add to `.claude/hooks/pre-commit.sh`:
+```bash
+#!/bin/bash
+cmp-memory sync --quick
+if [ $? -ne 0 ]; then
+  echo "Documentation sync failed"
+  exit 1
+fi
+```
+
+### CI Integration
+
+```yaml
+- name: Documentation Sync
+  run: |
+    cmp-memory sync
+    git diff --exit-code docs/
+```
+
+## Customization
+
+Configure in `project.config.json`:
+
+```json
+{
+  "sync": {
+    "healthCheck": true,
+    "schemaDoc": true,
+    "aiContext": true,
+    "i18n": false,
+    "financeSync": false,
+    "lintReport": true
+  }
+}
+```
+
+## When to Run
+
+### Automatic Triggers
+- Pre-commit (quick mode)
+- PR creation
+- Release preparation
+
+### Manual Triggers
+- After major refactors
+- Before important demos
+- Monthly maintenance
+
+---
+
+**Status**: Production Ready