Files

T

Universal: Pre-Release / Build Pre-Release (${{ inputs.stability || github.ref_name }}) (push) Successful in 23s

Details

chore(docs): normalize refs — MokoStandards->org wiki, moko-platform->mokocli, residual MokoGitea/MokoSuite

Non-workflow docs/config only (CLAUDE.md, README, branch-protection, ISSUE_TEMPLATE/config.yml,
ci-issue-reporter). Workflow files, manifest schema, and Makefile install paths left for the
forge-rebrand gate. Authored-by: Moko Consulting

2026-07-05 22:50:25 +00:00

2.2 KiB

Raw Blame History

CLAUDE.md

This file provides guidance to Claude Code when working with this repository.

Project Overview

MokoJoomHero -- Random hero image slideshow/video with content overlay for Joomla

Field	Value
Platform	joomla
Language	PHP
Default branch	main
License	GPL-3.0-or-later
Wiki	MokoJoomHero Wiki
Standards	MokoStandards

Common Commands

make build        # Build the project
make lint         # Run linters
make validate     # Validate structure
make release      # Full release pipeline
make minify       # Minify CSS/JS assets
make clean        # Clean build artifacts

composer install  # Install PHP dependencies

Architecture

This is a Joomla site module (mod_mokojoomhero).

Random hero image slideshow or background video with content overlay
Supports image folders, YouTube, Vimeo, local video, solid colour, gradient
Configurable overlay, text alignment, card animation, parallax, content animations
A/B testing with weighted variations, scheduling with start/end datetime
Article content source, per-slide unique content via subform

Key files

src/mod_mokojoomhero.xml — module manifest
src/mod_mokojoomhero.php — module entry point
src/tmpl/default.php — template
src/media/ — CSS, JS, and web asset registry
src/language/ — en-GB and en-US translations
src/script.php — install script (creates default image folder)

Rules

Workflow directory: .mokogitea/ (not .gitea/ or .github/)
Never commit .claude/, .mcp.json, TODO.md, or *.min.css/*.min.js
Attribution: use Authored-by: Moko Consulting in commits
Branch strategy: develop on dev, merge to main for release
Minification: handled at build time (CI)
Wiki: documentation lives in the MokoGitea wiki, not in docs/ files
Standards: this repo follows MokoStandards

Coding Standards

PHP 8.1+ minimum
SPDX license headers on all PHP files

2.2 KiB Raw Blame History