From 4e81b95fdf4c6c14dc353f665b0e6a1be80b53cb Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Sat, 7 Mar 2026 20:41:28 +0000 Subject: [PATCH] Remove client fork references from documentation - Update README.md to remove client fork sections - Update CLAUDE.md to remove client fork file references - Update copilot-instructions.md to remove client fork section - Update templates/README.md for empty directory - Update scripts/README.md to remove create-client-fork.sh - Update docs/README.md to remove CLIENT_FORK_WORKFLOW.md references Co-authored-by: jmiller-moko <230051081+jmiller-moko@users.noreply.github.com> --- .github/copilot-instructions.md | 8 ----- CLAUDE.md | 5 ++- README.md | 24 ++------------ docs/README.md | 21 ++---------- scripts/README.md | 16 +-------- templates/README.md | 58 ++++----------------------------- 6 files changed, 14 insertions(+), 118 deletions(-) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 880f9ca..c10ffb0 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -324,14 +324,6 @@ cd scripts - Use Joomla's security features (CSRF tokens, etc.) - Keep dependencies updated -## Client Forks - -For client-specific color customizations: -- Use automated workflow in `docs/CLIENT_FORK_WORKFLOW.md` -- Custom color files tracked via client fork .gitignore template -- Use Joomla's template settings for other customizations (Custom Code tab) -- Limited scope: colors only - ## License Compliance All code contributions must be: diff --git a/CLAUDE.md b/CLAUDE.md index 1b7487f..d5931f3 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -8,7 +8,7 @@ MokoCassiopeia is a modern, lightweight Joomla template that extends Cassiopeia MokoCassiopeia/ ├── .github/ # GitHub workflows (CI, testing, release), Copilot instructions ├── docs/ # Comprehensive documentation (guides, philosophy, CSS reference) -├── scripts/ # Build scripts (build-release.sh, create-client-fork.sh) +├── scripts/ # Build scripts (build-release.sh) ├── src/ # MAIN WORKING DIRECTORY: template source files │ ├── index.php # Main template rendering file │ ├── templateDetails.xml # Joomla manifest (metadata, params, files) @@ -198,7 +198,7 @@ From `phpcs.xml`: - **Alternative layouts**: Descriptive name + `.php` (e.g., `mobile.php`, `mainmenu.php`, `toc-left.php`) - **NEVER use**: `default.php` (replaces core layout—FORBIDDEN) -- **Scripts**: Lowercase with hyphens (e.g., `build-release.sh`, `create-client-fork.sh`) +- **Scripts**: Lowercase with hyphens (e.g., `build-release.sh`) ## Primary Language @@ -543,4 +543,3 @@ Must-read before contributing: - **CHANGELOG.md** - Version history and release notes - **GOVERNANCE.md** - Project governance model and decision-making - **CODE_OF_CONDUCT.md** - Community standards and expectations -- **CLIENT_FORK_WORKFLOW.md** - Automated setup for client color customizations diff --git a/README.md b/README.md index 67b2e8a..64bc9f3 100644 --- a/README.md +++ b/README.md @@ -328,16 +328,6 @@ See [Joomla Development Guide](./docs/JOOMLA_DEVELOPMENT.md) for packaging instr - **[CSS Variables Reference](./docs/CSS_VARIABLES.md)** - Complete CSS customization guide - **[Documentation Index](./docs/README.md)** - All documentation links -### Customization Resources - -- **[Template Files](./templates/)** - Ready-to-use templates for customization - - `colors_custom.css` - Custom color palette template - - `gitignore-template` - .gitignore template for client forks - -### Client Forks - -- **[Client Fork Workflow Guide](./docs/CLIENT_FORK_WORKFLOW.md)** - Automated setup for client color customizations - ### Governance - **[Contributing](./CONTRIBUTING.md)** - How to contribute @@ -404,19 +394,9 @@ We welcome contributions! Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for gu See [Workflow Guide](./docs/WORKFLOW_GUIDE.md) for detailed Git workflow. -### Client Custom Forks +### Customizations -Creating a custom fork for client-specific color branding? - -**Automated Workflow**: Use our streamlined workflow to create a client fork in minutes: -- **[Client Fork Workflow Guide](./docs/CLIENT_FORK_WORKFLOW.md)** - Automated GitHub Actions workflow or local bash script - -**What You Get**: -- Custom color files set up for light and dark modes -- .gitignore configured to track your custom colors -- Clean separation from upstream for easy syncing - -**For Other Customizations**: Use Joomla's built-in template settings (System → Site Templates → MokoCassiopeia → Custom Code tab) for HTML/CSS/JS customizations. +For template customizations, use Joomla's built-in template settings (System → Site Templates → MokoCassiopeia → Custom Code tab) for HTML/CSS/JS customizations. --- diff --git a/docs/README.md b/docs/README.md index ac9e318..f2909ef 100644 --- a/docs/README.md +++ b/docs/README.md @@ -94,20 +94,6 @@ This directory contains comprehensive documentation for the MokoCassiopeia Jooml For end-user documentation, installation instructions, and feature guides, see the main [README.md](../README.md) in the repository root. -### Client Fork Documentation - -* **[Client Fork Workflow](CLIENT_FORK_WORKFLOW.md)** - 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 Workflow Guide](./CLIENT_FORK_WORKFLOW.md)** - Automated setup for client color customizations - * Setting up custom brand colors for light and dark modes - * .gitignore template for tracking custom colors - * Syncing with upstream MokoCassiopeia - * Limited scope: colors only (use Joomla's template settings for other customizations) - ## Project Structure ``` @@ -119,7 +105,6 @@ moko-cassiopeia/ │ ├── JOOMLA_DEVELOPMENT.md # Joomla-specific development guide │ ├── CSS_VARIABLES.md # CSS variables reference │ ├── MODULE_OVERRIDES.md # Module & component overrides guide -│ ├── CLIENT_FORK_WORKFLOW.md # Client fork creation workflow │ └── ROADMAP.md # Version-specific roadmap ├── src/ # Template source code (Joomla template root) │ ├── component.php # Component template @@ -143,10 +128,8 @@ moko-cassiopeia/ │ └── language/ # Backend language files │ ├── en-GB/ # English (UK) system translations │ └── en-US/ # English (US) system translations -├── templates/ # Template files for customization -│ ├── colors_custom.css # Custom color palette template (copy to src/media/css/colors/) -│ ├── gitignore-template # .gitignore template for client forks -│ └── README.md # Guide to using templates +├── templates/ # Reserved for future template files +│ └── README.md # Templates directory guide ├── scripts/ # Build and utility scripts ├── tests/ # Automated tests └── .github/ # GitHub configuration and workflows diff --git a/scripts/README.md b/scripts/README.md index ab69614..0c3f452 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -37,19 +37,6 @@ This directory contains utility scripts for building, releasing, and managing th --- -### create-client-fork.sh - -**Purpose**: Create a customized client fork of MokoCassiopeia. - -**Usage**: -```bash -./scripts/create-client-fork.sh -``` - -See the script documentation for details on creating client-specific forks. - ---- - ## Automated Workflows The repository includes GitHub Actions workflows that automate the build and release process: @@ -253,8 +240,7 @@ Check: ``` scripts/ ├── README.md # This file -├── build-release.sh # Local build script -└── create-client-fork.sh # Client fork creation script +└── build-release.sh # Local build script .github/workflows/ ├── release.yml # Automated release workflow diff --git a/templates/README.md b/templates/README.md index bf3b9a3..34ce475 100644 --- a/templates/README.md +++ b/templates/README.md @@ -5,68 +5,25 @@ BRIEF: Template files directory README --> -# MokoCassiopeia Template Files +# MokoCassiopeia Templates Directory -This directory contains template files for client color customizations. +This directory is reserved for future template files and customization resources. ---- +## Custom Color Palettes -## 📁 Available Templates +For custom color schemes, you can create your own CSS files with custom CSS variables: -### Custom Color Scheme Template - -**File**: `colors_custom.css` - -A comprehensive template for creating custom color schemes. This template includes all CSS variables used by MokoCassiopeia for both light and dark modes. - -**Usage**: -1. Copy this file to either: - - `src/media/css/colors/light/colors_custom.css` (for light mode) - - `src/media/css/colors/dark/colors_custom.css` (for dark mode) -2. Customize the CSS variables to match your brand colors -3. Enable in Joomla: System → Site Templates → MokoCassiopeia → Theme tab -4. Set the appropriate palette to "Custom" +1. Create a new CSS file in `src/media/css/colors/light/` or `src/media/css/colors/dark/` +2. Define CSS variables following the pattern in `colors_standard.css` +3. Use Joomla's template settings (System → Site Templates → MokoCassiopeia → Custom Code tab) to load your custom CSS **Reference**: See [CSS Variables Documentation](../docs/CSS_VARIABLES.md) for complete variable reference. --- -### Client Fork .gitignore Template - -**File**: `gitignore-template` - -A .gitignore template for client forks that ensures custom color files are tracked in the fork repository while maintaining proper ignore rules for other files. - -**Usage**: -- Automatically applied when using the client fork creation workflow -- Can be manually copied to `.gitignore` in client fork repositories - ---- - -## 🎯 When to Use These Templates - -### Creating a Client Fork - -If you're creating a custom fork of MokoCassiopeia for a specific client: - -1. **Use the automated workflow**: See [CLIENT_FORK_WORKFLOW.md](../docs/CLIENT_FORK_WORKFLOW.md) -2. **Set up custom colors**: Use `colors_custom.css` as your starting point -3. **Test thoroughly**: Verify colors in both light and dark modes - -### Custom Colors Only - -If you just need custom colors without forking: - -1. Use the `colors_custom.css` template -2. Follow the instructions in the [main README](../README.md#custom-color-palettes) -3. Enable custom palette in Joomla template settings - ---- - ## 📚 Additional Resources - **[Main README](../README.md)** - MokoCassiopeia features and installation -- **[Client Fork Workflow](../docs/CLIENT_FORK_WORKFLOW.md)** - Automated fork setup guide - **[CSS Variables Reference](../docs/CSS_VARIABLES.md)** - All available CSS variables - **[Development Guide](../docs/JOOMLA_DEVELOPMENT.md)** - Development workflows @@ -74,5 +31,4 @@ If you just need custom colors without forking: **Template Directory**: `/templates/` **Version**: 03.08.04 -**Scope**: Colors only **Maintained by**: Moko Consulting