Skip to content

Documentation Update Workflow (Automated Agent Protocol)

This workflow is an automated procedure to be executed by the AI Agent. Use this whenever a Feature, Refactor, or significant Bugfix is completed to ensure the "Single Source of Truth" remains valid and is automatically deployed.

AGENT INSTRUCTION: When invoked, you MUST execute the following phases sequentially and autonomously. Do not ask for intermediate permission unless an error occurs.


Phase 1: Update Documentation (Local)

Agent Task: Update the local markdown files based on the recent development changes.

  1. Review the changes made during the development session.

  2. Place or update documentation in the appropriate layer:

    • 01_Strategy: Long-term vision, migration workflows, and core protocols.
    • 02_Architecture: Platform design, VPS infrastructure diagrams, and ADRs.
    • 03_Infrastructure: Operational guides, backup concepts, and server status.
    • 04_Development_Log: Tracking of changes and "Lessons Learned".
    • 05_Dev_Experience: Agent workflows, skills, and developer guidelines.
  3. Validate links: Run the local validation check to ensure no symlinks are broken.

    bash
    // turbo
    find docs -type l -exec test ! -e {} \; -print

Phase 2: Direct VPS Synchronization (SSH Sync)

Agent Task: Execute the local sync script to copy the documentation to the VPS (/opt/antigravity/data/PROJECT-DEVELOPMENT/cfs-platform/docs/) and update the VitePress sidebar.

  1. Execute the sync script:

    bash
    // turbo
    ./platform/linux/sync-vps-docs-manually.sh

Phase 3: Persist to Source of Truth (Git Commit & Push)

Agent Task: Commit all documentation changes and push them to the authoritative main branch.

  1. Stage, commit, and push:

    bash
    // turbo
    git add docs/ .agent/workflows/
    git commit -m "docs(encyclopedia): auto-update after development step"
    git push origin main

(Note: The documentation will only go "online" in the web frontend once the CFS Platform itself performs a push to trigger its own CI/CD pipeline).

Released under proprietary license.