Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions .github/ISSUE_TEMPLATE/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Issue Templates Directory"
description: "Standardized issue templates for the LightSpeedWP organization. Templates for bugs, features, documentation, and custom issues with automation integration."
name: "Issue Templates"
file_type: documentation
version: v1.6
version: v1.5
last_updated: "2026-06-18"
created_date: "2025-10-20"
authors: ["LightSpeed Team"]
Expand Down Expand Up @@ -46,10 +46,8 @@ For advanced usage, see the [Issue Template Index](./README.md) and individual t
## 🗂️ Issue Template Workflow

```mermaid
---
accTitle: Issue template workflow
accDescr: Shows the issue creation workflow from template selection through auto-population, agent processing, auto-labeling, issue type assignment, project board assignment, and notification routing, with template sync feeding all organisation repositories.
---
accDescr: Shows how users select an issue template, auto-populated fields flow into issue creation, and automation routes the issue to labelling, project, and notification steps.
flowchart TD
A[User Creates Issue] --> B{Select Template}
B -->|Bug Report| C[Bug Template]
Expand Down
26 changes: 13 additions & 13 deletions .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: LightSpeed .github Community Health Repository
description: Central hub for all shared GitHub templates, Copilot instructions, workflow
automation, labeling systems, and community health files across the LightSpeed WordPress
organisation
version: '3.5'
version: '3.6'
created_date: '2025-01-15'
last_updated: '2026-06-18'
authors:
Expand Down Expand Up @@ -116,10 +116,10 @@ accDescr {
P --> R
Q --> S

style A fill:#e1f5fe
style D fill:#fce4ec
style M fill:#e8f5e8
style R fill:#fff3e0
style A fill:#dbeafe,color:#1e3a5f,stroke:#1e3a5f
style D fill:#f3e8ff,color:#3b0764,stroke:#7e22ce
style M fill:#dcfce7,color:#14532d,stroke:#14532d
style R fill:#fef3c7,color:#4a2c00,stroke:#b45309
```

**Key goals:**
Expand Down Expand Up @@ -316,10 +316,10 @@ accDescr {
H --> H4
D --> D1

style A fill:#e1f5fe
style B fill:#fce4ec
style H fill:#e8f5e8
style D fill:#fff3e0
style A fill:#dbeafe,color:#1e3a5f,stroke:#1e3a5f
style B fill:#f3e8ff,color:#3b0764,stroke:#7e22ce
style H fill:#dcfce7,color:#14532d,stroke:#14532d
style D fill:#fef3c7,color:#4a2c00,stroke:#b45309
```

## Directory Structure Details
Expand Down Expand Up @@ -454,10 +454,10 @@ accDescr {
L --> P
M --> Q

style A fill:#e1f5fe
style E fill:#f3e5f5
style J fill:#e8f5e8
style N fill:#c8e6c9
style A fill:#dbeafe,color:#1e3a5f,stroke:#1e3a5f
style E fill:#f3e8ff,color:#3b0764,stroke:#7e22ce
style J fill:#dcfce7,color:#14532d,stroke:#14532d
style N fill:#dcfce7,color:#14532d,stroke:#14532d
```

## Component Integration Details
Expand Down
2 changes: 2 additions & 0 deletions .github/instructions/.archive/frontmatter.instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,8 @@ references:
- VS Code and Copilot validate automatically if configured (see `.vscode/settings.json`).

```mermaid
accTitle: Frontmatter validation flow
accDescr: Shows how a file with frontmatter moves through schema validation and either passes or returns for correction before automation uses it.
graph TD
A[File with Frontmatter] --> B[Schema Validation]
B -->|Valid| C[Accepted]
Expand Down
6 changes: 6 additions & 0 deletions .github/instructions/.archive/tests.instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,8 @@ You are the test style and quality enforcer for LightSpeed projects. Maintain co
## 🧪 Testing Pyramid

```mermaid
accTitle: Testing pyramid overview
accDescr: Shows how end-to-end, integration, unit, and static analysis layers stack within the testing strategy.
graph TD
A[E2E Tests<br/>Playwright] --> B[Integration Tests<br/>Jest + PHPUnit]
B --> C[Unit Tests<br/>Jest + PHPUnit + pytest]
Expand All @@ -94,6 +96,8 @@ graph TD
## 🔄 Test Execution Flow

```mermaid
accTitle: Test execution flow
accDescr: Shows how a developer runs local tests, receives coverage feedback, and then CI repeats the test stages and quality gate checks.
sequenceDiagram
participant Dev as Developer
participant Local as Local Tests
Expand Down Expand Up @@ -173,6 +177,8 @@ sequenceDiagram
## 📊 Test Coverage Matrix

```mermaid
accTitle: Test coverage matrix
accDescr: Shows how code changes branch into unit, integration, and end-to-end tests before reaching the quality gate.
graph LR
A[Code Changes] --> B{Test Type}
B --> C[Unit Tests<br/>Fast & Isolated]
Expand Down
50 changes: 26 additions & 24 deletions .github/prompts/update-mermaid-diagrams.prompt.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,29 @@
---
file_type: "prompt"
title: "Update Mermaid Diagrams"
description: "Refresh Mermaid diagrams across the repository or targeted paths with WCAG 2.2 AA colour contrast, updated content, and current standards."
description: "Refresh Mermaid diagrams across the repository with WCAG 2.2 AA contrast, explicit accessibility metadata, and current repository standards."
mode: "agent"
tools: ["read", "edit", "search", "shell"]
tags: ["mermaid", "documentation", "a11y", "wcag", "colour-contrast", "readme", "automation"]
tags: ["mermaid", "documentation", "a11y", "wcag", "colour-contrast", "readme"]
last_updated: "2026-06-18"
---

# Update Mermaid Diagrams

Refresh Mermaid diagrams across the repository to conform with the v2.0 standards in `instructions/mermaid.instructions.md`.
Refresh Mermaid diagrams across the repository to conform with the current standards in `instructions/mermaid.instructions.md`.

## Standards Reference

- **Instructions**: `instructions/mermaid.instructions.md` — v2.0 approved palette, required structure, emoji vocabulary
- **Validator**: `scripts/validation/validate-mermaid-colour-contrast.js` — WCAG 2.2 AA contrast checker
- **Workflow**: `.github/workflows/validate-mermaid-pr.yml` — PR enforcement
- **Instructions**: `instructions/mermaid.instructions.md` - required structure, palette, and accessibility rules
- **Validator**: `scripts/validation/validate-mermaid-accessibility.js` - accTitle / accDescr checks
- **Validator**: `scripts/validation/validate-mermaid-colour-contrast.js` - WCAG 2.2 AA colour contrast checks
- **Workflow**: `.github/workflows/readme-audit.yml` and `.github/workflows/readme-update.yml` - audit and update automation

## What to Fix in Every Diagram

### 1. Required accessibility header block

Every `\`\`\`mermaid` block must open with a YAML header before the diagram type:
Every `\`\`\`mermaid` block must open with an accessibility header before the diagram type:

```text
---
Expand All @@ -46,19 +47,19 @@ accDescr {

Remove any legacy inline `accTitle` / `accDescr` attributes that appear after the diagram type line.

### 2. Approved colour palette — replace ALL old `style` declarations
### 2. Approved colour palette

Replace every old `style X fill:#colour` (single property) with an approved triple. Choose the role that best matches the node's meaning:
Replace every `style` or `classDef` declaration that sets a `fill:` colour with an approved triple. Choose the role that best matches the node's meaning:

| Role | fill | color | stroke |
|------|------|-------|--------|
| Information (entry points, primary) | `#dbeafe` | `#1e3a5f` | `#1e3a5f` |
| Success (outputs, completed) | `#dcfce7` | `#14532d` | `#14532d` |
| Warning (caution, external) | `#fef3c7` | `#4a2c00` | `#b45309` |
| Error / Alert (failure, blockers) | `#fee2e2` | `#7f1d1d` | `#b91c1c` |
| Documentation (specs, instructions, AI) | `#f3e8ff` | `#3b0764` | `#7e22ce` |
| Neutral (connectors, supporting) | `#f1f5f9` | `#0f172a` | `#334155` |
| Highlight (automation, key actions) | `#ecfdf5` | `#064e3b` | `#059669` |
| Information | `#dbeafe` | `#1e3a5f` | `#1e3a5f` |
| Success | `#dcfce7` | `#14532d` | `#14532d` |
| Warning | `#fef3c7` | `#4a2c00` | `#b45309` |
| Error / Alert | `#fee2e2` | `#7f1d1d` | `#b91c1c` |
| Documentation | `#f3e8ff` | `#3b0764` | `#7e22ce` |
| Neutral | `#f1f5f9` | `#0f172a` | `#334155` |
| Highlight | `#ecfdf5` | `#064e3b` | `#059669` |

Example:

Expand All @@ -70,7 +71,7 @@ style C fill:#dcfce7,color:#14532d,stroke:#14532d

### 3. Diagram type and direction

- Prefer `flowchart` over `graph` (current Mermaid standard).
- Prefer `flowchart` over `graph`.
- Always specify direction: `flowchart LR`, `flowchart TD`, etc.

### 4. Emoji vocabulary
Expand All @@ -92,28 +93,29 @@ Update diagram content to reflect the current codebase. Check:

## Process

1. Run the contrast validator to get the full list of affected files:
1. Run the Mermaid validators to identify all affected files:

```bash
npm run validate:mermaid-accessibility
npm run validate:mermaid-contrast
```

2. For each file with findings, open it and apply the fixes above.

3. After fixing all files, run the full suite to confirm zero failures:
3. After fixing all files, run the full Mermaid suite:

```bash
npm run validate:mermaid
```

4. If adding new diagrams to README files that don't have one, ensure the diagram accurately represents what that file/folder contains.
4. If a documentation file does not yet contain a diagram, only add one when the visual adds clear value over prose.

## Validation Gate

All three checks must pass before committing:
All Mermaid checks must pass before merging:

```bash
npm run validate:mermaid-syntax # diagram type, direction, bracket matching
npm run validate:mermaid-accessibility # accTitle and accDescr present
npm run validate:mermaid-contrast # WCAG 2.2 AA colour contrast
npm run validate:mermaid-syntax
npm run validate:mermaid-accessibility
npm run validate:mermaid-contrast
```
Loading
Loading