MokoConsulting/moko-platform

Fork 0

Table of Contents

Wiki Standards

Page Structure

Required elements

Home Page Standard
Content Guidelines

Formatting
Writing style

Page Categories
Naming Conventions
Metadata Footer

Metadata table fields

Required Repository Files

Required (positive points)
Disallowed (flagged if present)
Manifest

CLAUDE.md Standard
Repo Health Check
GitHub Mirror
Related

← Back to Home

Wiki Standards

Standards and conventions for all wiki documentation across the Moko Consulting ecosystem.

Page Structure

Every wiki page must follow this structure:

[← Back to Home](Home)

# Page Title

Brief description of what this page covers.

---

## Section 1
Content...

---

## Related

- [Other Page](Other-Page) -- description

---

*Repo: [RepoName](repo-url) · [moko-platform](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*

| Field | Value |
|---|---|
| Minimum Version | XX.YY.ZZ |
| Platform | joomla / dolibarr / mcp-server / generic |
| Applies To | All repositories / Joomla only / etc. |

| Revision | Date | Author | Description |
|---|---|---|---|
| 1.0 | YYYY-MM-DD | Moko Consulting | Initial version |

Required elements

Element	Location	Purpose
Navigation link	First line	`[← Back to Home](Home)`
H1 title	After nav	Page title matching the wiki page name
Description	After title	1-2 sentence summary
Horizontal rules	Between major sections	`---` separators
Related section	Before footer	Links to related pages
Metadata footer	Last lines	Repo link, moko-platform link, metadata table, revision table

Home Page Standard

Every repo wiki must have a Home page with:

Section	Required	Description
H1 project name	Yes	Project name as heading
Tagline	Yes	One-sentence description
Info table	Yes	Type, language, license, platform
Overview	Yes	Key context about the project
Wiki pages index	Yes	Organized links to all wiki pages, grouped by category
Related wikis	Recommended	Links to related project wikis
moko-platform backlink	Yes	Link to moko-platform wiki Home

Content Guidelines

Formatting

Rule	Description
Tables for structured data	Not bullet lists for key-value pairs
Code blocks with language	```bash, ```json, ```php
Headers for sections	H2 for major, H3 for subsections
Horizontal rules	`---` between major sections
No emojis in headers	Plain text only
Em dashes	Use `--` not unicode

Writing style

Concise -- lead with the answer
Scannable -- headers, tables, short paragraphs
Accurate -- built from source code, not assumptions
Actionable -- include commands, file paths, examples
Current -- update when code changes

Page Categories

Category	Content
Guides	Installation, Configuration, Getting Started
Reference	API, Tools, CSS Variables, Endpoints
Operations	Backup, Restore, Monitoring, Troubleshooting
Architecture	System design, How It Works, Data Flow
Development	Contributing, Release Process, Testing

Naming Conventions

Type	Format	Example
Guide pages	Title case	`Installation`, `Getting-Started`
Reference pages	UPPER_CASE	`WIKI_STANDARDS`, `MINIFICATION`
Technical pages	Title case	`Architecture`, `Configuration`
Compound names	Hyphenated	`Custom-Themes`, `Backup-Recovery`

Metadata Footer

Every page ends with a metadata section containing the repo link, a metadata table, and a revision history table.

---

*Repo: [RepoName](https://git.mokoconsulting.tech/Owner/Repo) · [moko-platform](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*

| Field | Value |
|---|---|
| Minimum Version | 04.07.00 |

| Revision | Date | Author | Description |
|---|---|---|---|
| 1.0 | 2026-05-09 | Moko Consulting | Initial version |

Metadata table fields

Field	Required	Description
Minimum Version	Yes	The moko-platform version this page applies to. Use the standards version from the `.mokostandards` manifest, not the repo's own version. Update when content depends on features from a newer standards version. Omit only on the Home page (which is version-agnostic).
Platform	Recommended	Which platform(s) the page applies to: `joomla`, `dolibarr`, `mcp-server`, `generic`, or `all`
Applies To	Recommended	Scope: `All repositories`, `Joomla extensions only`, `MCP servers only`, specific repo name, etc.

Additional fields may be added per-page as needed.

Required Repository Files

Per the repo health check (check_repo_health.php), every repo must have:

Required (positive points)

File	Points	Purpose
`README.md`	8	Project overview (mirrors wiki Home)
`LICENSE`	8	GPL-3.0-or-later
`CHANGELOG.md`	5	Release history with [Unreleased] section
`CLAUDE.md`	5	Claude Code context (project overview, commands, architecture, rules)
`CONTRIBUTING.md`	4	Contribution guidelines
`SECURITY.md`	4	Security policy
`.gitignore`	3	Must include: `.claude/`, `TODO.md`, `.min.css`, `.min.js`
`Makefile`	3	Build targets (minify, build, release)

Disallowed (flagged if present)

File	Reason
`TODO.md`	Use issue tracker, not committed files
`.claude/`	Local workspace config
`.mcp.json`	Local MCP config
`renovate.json`	Removed from ecosystem
`profile.ps1`	Local PowerShell profile
`vendor/`	Install via composer, don't commit
`node_modules/`	Install via npm, don't commit
`.env` / `credentials.json`	Secrets never committed

Manifest

Every repo must have .mokogitea/.moko-platform XML manifest with:

Identity (name, org, description, license)
Governance (platform type, standards version)
Build (language, package type, entry point)

CLAUDE.md Standard

Every repo must have a CLAUDE.md that provides context to Claude Code:

# CLAUDE.md

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

## Project Overview
**RepoName** -- description

| Field | Value |
|---|---|
| **Platform** | joomla / dolibarr / mcp-server / client / template / generic |
| **Language** | PHP / TypeScript / Shell |
| **Default branch** | main or dev |
| **Wiki** | [Wiki link](wiki-url) |
| **Standards** | [moko-platform](moko-platform-wiki-url) |

## Common Commands
(make targets, npm scripts, composer commands)

## Architecture
(key directories and files for this platform type)

## Rules
- Never commit .claude/, .mcp.json, TODO.md, *.min.css/js
- Attribution: Authored-by: Moko Consulting
- Branch strategy: dev → main
- Standards: moko-platform

Repo Health Check

The check_repo_health.php script validates repos against these standards:

Category	Points	Checks
Required Files	40	README, LICENSE, CHANGELOG, CONTRIBUTING, SECURITY, CLAUDE.md, .gitignore, Makefile
Manifest & Config	20	.moko-platform, workflows, README quality, .gitignore content, CLAUDE.md quality
Documentation	15	No docs/ (wiki-first), CHANGELOG [Unreleased]
Disallowed	10	No TODO.md, vendor/, node_modules/, .claude/, .mcp.json, renovate.json, profile.ps1
Workflows	15	repo-health, sync-roadmap-wiki, CI/deploy
Security	20	SECURITY.md, scanning workflow, no renovate.json, no secrets
Rulesets	15	Main protected, dev branch, branch protections
Deployment	10	Deploy workflow, build system

Threshold: 70% to pass.

GitHub Mirror

All wikis are backed up daily to mokoconsulting-tech/wiki on GitHub via sync-wikis-to-github.sh (runs daily at 5am UTC). Auto-discovers all repos with wikis across all orgs.

File-Header-Standards -- source file comment headers
MINIFICATION -- asset build standards
WORKFLOW_STANDARDS -- CI/CD conventions
Documentation-Standards -- code documentation standards

Repo: moko-platform · moko-platform wiki

Field	Value
Minimum Version	04.07.00

Revision	Date	Author	Description
1.0	2026-05-09	Moko Consulting	Initial version
2.0	2026-05-10	Moko Consulting	Added CLAUDE.md standard, repo health check details, required/disallowed files
3.0	2026-05-11	Moko Consulting	Added Minimum Version field to metadata table; linked File-Header-Standards