Skip to content

Welcome to LogiDAV Documentation

  • Cronjob Documentation

    Comprehensive documentation for all 164 production cronjobs with risk classification and code traceability.

    View Cronjobs

  • Coverage Status

    82% code linkage achieved (95/115 commands)

    46 critical risk commands identified

    Progress Report

  • Risk Classification

    Commands classified by business impact: Critical, High, Medium, Unknown

    Risk Analysis

  • System Crontab

    Source of truth for all cronjob definitions

    View Crontab

About This Documentation

This documentation system treats cronjobs as production-critical workflows that deserve first-class documentation and CI enforcement. Cronjobs run silently in the background and represent significant operational risk when undocumented.

Key Features

  • Automated Generation: Documentation generated from system-crontab.md source
  • Code Traceability: Links to Symfony Command class files
  • Risk Assessment: Critical/high/medium classification based on business impact
  • CI Enforcement: Automated validation on every commit
  • Progress Tracking: Coverage statistics and prioritized TODOs

System Architecture

graph TD
    A[system-crontab.md] -->|Parse| B[Python Generator]
    B -->|Extract| C[164 Cron Entries]
    C -->|Normalize| D[115 Unique Commands]
    D -->|Locate| E[Command Classes]
    D -->|Classify| F[Risk Levels]
    E --> G[Documentation Files]
    F --> G
    G --> H[CI Validation]
    H -->|Pass/Warn| I[Coverage Report]

Quick Start

# View coverage report
cat docs/meta/documentation-progress.md

# Check specific cronjob
cat docs/cronjobs/menzzo-v2-sales.md

# Regenerate all documentation
python3 tools/cronjob_doc_generator.py

# 1. Update system crontab
crontab -e

# 2. Sync to docs
php bin/console logidav:cron:document

# 3. Regenerate documentation
python3 tools/cronjob_doc_generator.py

# 4. Commit changes
git add docs/ && git commit -m "docs: update cronjobs"

Documentation Coverage

Metric Value Status
Total Cron Entries 164 100% parsed
Unique Commands 115 100% documented
Code Linkage 95/115 (82%) High coverage
Critical Risk 46 Need documentation
High Risk 40 Need documentation

Risk Breakdown

Critical (46 commands)

Commands involving sales, payments, refunds, or stock mutations. These have immediate business impact.

Examples: menzzo:v2:sales, menzzo:v2:sales:payment, menzzo:refund:check

High (40 commands)

Commands with significant business impact: products, sync, orders, imports.

Examples: menzzo:v2:products, menzzo:sync:shipping-rates, menzzo:product:stat

Medium (8 commands)

Supporting commands: logs, stats, alerts, notifications.

Unknown (21 commands)

Need risk assessment through code inspection.

Next Steps

  • Priority 1: Critical Commands

    Document 46 critical risk commands that handle sales, payments, refunds, and stock.

  • Priority 2: Locate Classes

    Find 20 missing Command class files through manual investigation.

  • Priority 3: Risk Assessment

    Assess 21 commands with unknown risk levels.

  • Phase 2: Annotations

    Add @doc.* annotations to Command classes for automated documentation enhancement.

Additional Resources

Maintenance Schedule

  • Daily: Monitor CI results
  • Weekly: Update critical command docs
  • Monthly: Review progress report
  • Quarterly: Check for stale documentation