Documentation Workflow

Last Updated: August 9, 2024
Author: Shanta
Status: Active

Overview

The Comserv Documentation System provides a structured way to organize, categorize, and display documentation files for different user roles and sites. This document outlines the workflow for creating, updating, and maintaining documentation in the system. It incorporates the updates from the 2025-04 documentation workflow update to provide comprehensive guidance on documentation development.

Documentation Structure

The documentation is organized in the following directory structure:

/root/Documentation/
  ├── roles/
  │   ├── admin/         # Admin-only documentation
  │   ├── normal/        # Regular user documentation
  │   └── developer/     # Developer documentation
  ├── tutorials/         # Step-by-step guides
  ├── developer/         # Developer-specific documentation
  ├── proxmox/           # Proxmox-related documentation
  ├── changelog/         # System changes and updates
  ├── controllers/       # Controller documentation
  ├── models/            # Model documentation
  ├── sites/             # Site-specific documentation
  │   └── mcoop/         # MCOOP-specific documentation
  ├── documentation_config.json  # Configuration file for documentation
  └── completed_items.json       # Recent updates tracking


  










  
  - Detailed explanation of what was changed and why