MokoCassiopeia Documentation
This directory contains comprehensive documentation for the MokoCassiopeia Joomla template.
Documentation Overview
Developer Documentation
-
Quick Start Guide - Get up and running in 5 minutes
- Development environment setup
- Essential commands and workflows
- First-time contributor guide
-
Workflow Guide - Complete workflow reference
- Git branching strategy
- Development workflow
- Release process
- Pull request guidelines
-
Joomla Development Guide - Joomla-specific development
- Testing with Codeception
- PHP quality checks (PHPStan, PHPCS)
- Joomla extension packaging
- Multi-version testing
-
CSS Variables Reference - Complete CSS customization guide
- All available CSS variables
- Custom color palette creation
- Usage examples and tips
- Light and dark mode theming
-
Module & Component Overrides - Mobile-responsive overrides guide
- 20 module overrides + 3 component overrides
- VirtueMart, Joomla core, Community Builder, industry extensions
- Mobile-first responsive design patterns
- Accessibility features and customization
-
Roadmap - Version-specific roadmap
- Current features (v03.07.00)
- Feature evolution timeline
- Planned enhancements
- Development priorities
User Documentation
For end-user documentation, installation instructions, and feature guides, see the main README.md in the repository root.
Client Fork Documentation
-
Client Fork Workflow - Automated client fork creation
- GitHub Actions workflow for instant fork setup
- Local bash script alternative
- Complete setup automation in minutes
- Post-setup customization guide
-
Client Fork Guide - Comprehensive guide for client custom code forks
- Setting up custom branding and colors
- Maintaining fork-specific customizations
- Syncing with upstream MokoCassiopeia
- Deployment and development workflows
- Template README for client forks
Project Structure
moko-cassiopeia/
├── docs/ # Documentation (you are here)
│ ├── README.md # This file - documentation index
│ ├── QUICK_START.md # Quick start guide for developers
│ ├── WORKFLOW_GUIDE.md # Development workflow guide
│ ├── JOOMLA_DEVELOPMENT.md # Joomla-specific development guide
│ ├── CSS_VARIABLES.md # CSS variables reference
│ ├── MODULE_OVERRIDES.md # Module & component overrides guide
│ └── ROADMAP.md # Version-specific roadmap
├── src/ # Template source code
│ ├── templates/ # Joomla template files
│ │ └── html/ # Module & component overrides (20 modules, 3 components)
│ ├── media/ # Assets (CSS, JS, images)
│ │ └── css/colors/ # Color schemes (light/dark subdirectories)
│ │ ├── light/ # Light mode color files (colors_custom.css)
│ │ └── dark/ # Dark mode color files (colors_custom.css)
│ └── language/ # Translation files
├── templates/ # Template files for customization
│ ├── colors_custom.css # Custom color palette template (copy to src/media/css/colors/)
│ ├── CLIENT_FORK_README_TEMPLATE.md # Template for client fork docs
│ └── README.md # Guide to using templates
├── tests/ # Automated tests
├── CLIENT_FORK_README.md # Client fork guide
└── .github/ # GitHub configuration and workflows
Contributing
Before contributing, please read:
- CONTRIBUTING.md - Contribution guidelines and standards
- CODE_OF_CONDUCT.md - Community standards and expectations
- SECURITY.md - Security policy and reporting procedures
Standards Compliance
This project adheres to MokoStandards for:
- Coding standards and formatting
- Documentation requirements
- Git workflow and branching
- CI/CD pipeline configuration
- Security scanning and dependency management
Additional Resources
- Repository: https://github.com/mokoconsulting-tech/MokoCassiopeia
- Issue Tracker: GitHub Issues
- Changelog: CHANGELOG.md
- License: GPL-3.0-or-later
Support
- Email: hello@mokoconsulting.tech
- Website: https://mokoconsulting.tech/support/joomla-cms/moko-cassiopeia-roadmap
Metadata
- Document: docs/README.md
- Repository: https://github.com/mokoconsulting-tech/MokoCassiopeia
- Path: /docs/README.md
- Owner: Moko Consulting
- Version: 03.07.00
- Status: Active
- Effective Date: 2026-01-30
- Classification: Public Open Source Documentation
Revision History
| Date | Change Summary | Author |
|---|---|---|
| 2026-02-22 | Added MODULE_OVERRIDES.md reference, updated version to 03.07.00 | GitHub Copilot |
| 2026-01-30 | Added CSS Variables reference, updated version to 03.06.03 | GitHub Copilot |
| 2026-01-09 | Initial documentation index created for MokoStandards compliance. | GitHub Copilot |
| 2026-01-27 | Updated with roadmap link and version to 03.05.01. | GitHub Copilot |