3.3 KiB
MokoWaaS-Brand Documentation Index (VERSION: 01.03.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 MokoCodingDefaults for formatting, metadata placement, and content alignment.
Revision History
| Date | Author | Description |
|---|---|---|
| 2025-12-11 | Jonathan Miller (@jmiller-moko) | Full rewrite and update to version 01.03.00 |