copilot-swe-agent[bot]
04b99e0216
Co-authored-by: jmiller-moko <230051081+jmiller-moko@users.noreply.github.com>
79 lines
3.5 KiB
Markdown
79 lines
3.5 KiB
Markdown
<!--
|
|
Copyright (C) 2025 Moko Consulting <hello@mokoconsulting.tech>
|
|
This file is part of a Moko Consulting project.
|
|
SPDX-LICENSE-IDENTIFIER: GPL-3.0-or-later
|
|
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
|
|
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the IMPLIED WARRANTY of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
|
You should have received a copy of the GNU General Public License (./LICENSE.md).
|
|
|
|
# FILE INFORMATION
|
|
DEFGROUP: Joomla.Plugin
|
|
INGROUP: MokoWaaS-Brand.Documentation
|
|
REPO: https://github.com/mokoconsulting-tech/mokowaasbrand
|
|
VERSION: 01.04.00
|
|
PATH: /docs/index.md
|
|
BRIEF: Master index of all documentation for the MokoWaaS-Brand plugin
|
|
NOTE: Automatically maintained index for all guide canvases
|
|
-->
|
|
|
|
# MokoWaaS-Brand Documentation Index (VERSION: 01.04.00)
|
|
|
|
## Introduction
|
|
|
|
The MokoWaaS-Brand Documentation Index provides the authoritative map of all documentation assets associated with the MokoWaaS-Brand system plugin. It ensures traceability, governance compliance, and visibility across all operational, technical, and administrative materials that support WaaS-managed Joomla environments.
|
|
|
|
This index serves as the entry point for contributors, administrators, and governance teams who require a single source of truth for locating and validating documentation files.
|
|
|
|
## Documentation Structure
|
|
|
|
Documentation is organized into two primary categories: core documentation and operational guides. Each file is individually versioned, governed, and maintained as part of the WaaS documentation ecosystem.
|
|
|
|
### Core Documentation
|
|
|
|
* **Plugin Overview**
|
|
`/docs/plugin-basic.md`
|
|
|
|
### Guides
|
|
|
|
* **Installation Guide**
|
|
`/docs/guides/installation-guide.md`
|
|
|
|
* **Configuration Guide**
|
|
`/docs/guides/configuration-guide.md`
|
|
|
|
* **Operations Guide**
|
|
`/docs/guides/operations-guide.md`
|
|
|
|
* **Troubleshooting Guide**
|
|
`/docs/guides/troubleshooting-guide.md`
|
|
|
|
* **Upgrade and Versioning Guide**
|
|
`/docs/guides/upgrade-and-versioning-guide.md`
|
|
|
|
* **Rollback and Recovery Guide**
|
|
`/docs/guides/rollback-and-recovery-guide.md`
|
|
|
|
## Maintenance and Governance
|
|
|
|
To preserve documentation integrity across the WaaS platform, the following standards apply:
|
|
|
|
* All files must include the standard Moko Consulting metadata header.
|
|
* Version changes must be reflected both in the header and revision history.
|
|
* Newly created documentation must be added to this index immediately.
|
|
* Documentation should remain consistent with platform terminology, governance rules, and branding policy.
|
|
|
|
## Contribution Expectations
|
|
|
|
Contributors should:
|
|
|
|
* Maintain consistency with the established structure and tone of existing documents.
|
|
* Validate cross-document references when updating terminology or behavior.
|
|
* Follow [MokoStandards](https://github.com/mokoconsulting-tech/MokoStandards) for formatting, metadata placement, and content alignment.
|
|
|
|
## Revision History
|
|
|
|
| Date | Author | Description |
|
|
| ---------- | ------------------------------- | ------------------------------------------- |
|
|
| 2026-02-22 | GitHub Copilot | Update to version 01.04.00 |
|
|
| 2025-12-11 | Jonathan Miller (@jmiller-moko) | Full rewrite and update to version 01.03.00 |
|