Skip to content

fix(docs): remove prohibited references: frontmatter field from 9 READMEs #527

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ashleyshaw merged 12 commits into from
May 28, 2026
Merged

fix(docs): remove prohibited references: frontmatter field from 9 READMEs #527

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
51ecbec
fix(docs): remove prohibited references: field from 9 READMEs; fix mi…
claude May 28, 2026
2406420
fix(docs): fix duplicate last_updated key and broken relative link
claude May 28, 2026
13d34af
fix(docs): fix stale relative links in .github/README.md
claude May 28, 2026
ad611e1
fix(docs): resolve README link + frontmatter CI failures
ashleyshaw May 28, 2026
700fae2
fix(ci): remove duplicate footers; add .lycheeignore for crawler-bloc…
claude May 28, 2026
5a9d98f
fix(ci): expand .lycheeignore with org external domains
claude May 28, 2026
a73154d
docs: add portable AI plugin restructure migration maps to MIGRATION.md
claude May 28, 2026
5c36a72
fix(ci): broaden .lycheeignore patterns to match bare domain URLs
claude May 28, 2026
b1d1920
fix(docs): address PR 527 review comments and broken coverage links
ashleyshaw May 28, 2026
e07875d
fix(ci): restore plain-URL syntax in .lycheeignore; add lsx-demo-them…
claude May 28, 2026
4687413
fix(docs): resolve PR 527 lint-and-links failures
ashleyshaw May 28, 2026
5fc8189
fix(docs): remove non-versioned coverage links from tests readme
ashleyshaw May 28, 2026
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
58 changes: 13 additions & 45 deletions .github/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,15 @@
file_type: "documentation"
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.1"
version: "3.2"
created_date: "2025-01-15"
last_updated: "2025-12-04"
last_updated: "2026-05-28"
authors: ["LightSpeed Team"]
maintainer: "LightSpeed Team"
license: "GPL-3.0"
domain: "governance"
stability: "stable"
status: "active"
owners:
- LightSpeed Team
tags:
Expand All @@ -20,35 +21,6 @@ tags:
- workflows
- labeling
- ai
references:
- path: ./custom-instructions.md
description: Custom instructions for AI agents
- path: ./agents/agent.md
description: Main agents index
- path: ./prompts/prompts.md
description: Prompts index
- path: ../AGENTS.md
description: Organization-wide agents documentation
- path: ../docs/AUTOMATION_GOVERNANCE.md
description: Automation governance policies
- path: ./labels.yml
description: Label definitions
- path: ./labeler.yml
description: Labeler configuration
- path: ./issue-types.yml
description: Issue type definitions
- path: ./instructions/coding-standards.instructions.md
description: Coding standards instructions
- path: ./instructions/linting.instructions.md
description: Linting standards index
- path: ./instructions/tests.instructions.md
description: Testing standards index
- path: ./workflows/README.md
description: Workflows directory index
- path: ../CONTRIBUTING.md
description: Contribution guidelines
- path: ../docs/README.md
description: Documentation hub
---

# 🏛️ LightSpeed Organisation .github Community Health Repository
Expand Down Expand Up @@ -477,12 +449,12 @@ Have questions, feedback, or want to propose an idea? Visit our [GitHub Discussi
For all contributors, please reference these key guidelines and indexes:

- [LightSpeed General Copilot Instructions](https://github.com/lightspeedwp/.github/blob/HEAD/.github/custom-instructions.md)
- [Coding Standards](https://github.com/lightspeedwp/.github/blob/HEAD/.github/instructions/coding-standards.instructions.md)
- [HTML Templates](https://github.com/lightspeedwp/.github/blob/HEAD/.github/instructions/block-theme/html-template.instructions.md)
- [Pattern Development](https://github.com/lightspeedwp/.github/blob/HEAD/.github/instructions/block-theme/pattern-development.instructions.md)
- [PHP Block Instructions](https://github.com/lightspeedwp/.github/blob/HEAD/.github/instructions/block-theme/php-block.instructions.md)
- [Theme JSON](https://github.com/lightspeedwp/.github/blob/HEAD/.github/instructions/block-theme/theme-json.instructions.md)
- When generating a summary for pull requests, use this [pull request template](https://github.com/lightspeedwp/.github/blob/HEAD/.github/PULL_REQUEST_TEMPLATE.md).
- [Coding Standards](https://github.com/lightspeedwp/.github/blob/HEAD/instructions/coding-standards.instructions.md)
- [HTML Templates](https://github.com/lightspeedwp/.github/blob/HEAD/.github/instructions/plugin-structure.instructions.md)
- [Pattern Development](https://github.com/lightspeedwp/.github/blob/HEAD/.github/instructions/plugin-structure.instructions.md)
- [PHP Block Instructions](https://github.com/lightspeedwp/.github/blob/HEAD/.github/instructions/plugin-structure.instructions.md)
- [Theme JSON](https://github.com/lightspeedwp/.github/blob/HEAD/.github/instructions/plugin-structure.instructions.md)
- When generating a summary for pull requests, use this [pull request template](https://github.com/lightspeedwp/.github/blob/HEAD/.github/pull_request_template.md).

---

Expand Down Expand Up @@ -575,10 +547,10 @@ This repository and all its contents are licensed under the GNU General Public L

## 🔧 Development Standards

- [💻 Coding Standards](./instructions/coding-standards.instructions.md) - Unified development guidelines
- [🎨 Linting Instructions](./instructions/linting.instructions.md) - Code quality and formatting
- [🏗️ Pattern Development](./instructions/block-theme/pattern-development.instructions.md) - WordPress block patterns
- [🌐 HTML Templates](./instructions/block-theme/html-template.instructions.md) - Semantic markup standards
- [💻 Coding Standards](../instructions/coding-standards.instructions.md) - Unified development guidelines
- [🎨 Linting Instructions](../instructions/linting.instructions.md) - Code quality and formatting
- [🏗️ Pattern Development](./instructions/plugin-structure.instructions.md) - WordPress block patterns
- [🌐 HTML Templates](./instructions/plugin-structure.instructions.md) - Semantic markup standards

---

Expand All @@ -587,7 +559,3 @@ This repository and all its contents are licensed under the GNU General Public L
**❓ Questions?** [Open an issue](https://github.com/lightspeedwp/.github/issues/new), start a [Discussion](https://github.com/orgs/lightspeedwp/discussions), or contact [support@lightspeedwp.agency](mailto:support@lightspeedwp.agency)

*Built by 🧱 LightSpeedWP with ☕, 🚀, and open-source spirit!*
[Contributors](https://github.com/lightspeedwp/lsx-demo-theme/graphs/contributors)

*Built by 🧱 LightSpeedWP with ☕, 🚀, and open-source spirit!*
[Contributors](https://github.com/lightspeedwp/lsx-demo-theme/graphs/contributors)
11 changes: 4 additions & 7 deletions .github/agents/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,16 @@
file_type: "index"
title: ".github Agents Boundary"
description: "Repo-local index for agent assets that remain under the .github control-plane boundary."
version: "v0.2.0"
last_updated: "2026-05-20"
version: "v0.2.1"
last_updated: "2026-05-28"
maintainer: "LightSpeed Team"
authors: ["Codex"]
license: "GPL-3.0"
tags: ["agents", "github-boundary", "ai-ops"]
owners: ["LightSpeed Team"]
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot May 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

To ensure contributors can follow the migration rules mentioned in this README, please document the migration maps and notes in a central '/docs/MIGRATION.md' file.

References
  1. Document migration maps and notes in a central '/docs/MIGRATION.md' file to ensure contributors can follow migration rules mentioned in README files across the repository.

domain: "governance"
stability: "draft"
references:
- path: "../../agents/README.md"
description: "Portable agent specification library index."
- path: "../projects/active/portable-ai-plugin-restructure/issues/children/batch-02-portable-migration/02-04-refactor-migrate-portable-agent-specs.md"
description: "Issue #296 local source draft."
status: "active"
---

# .github Agents Boundary
Expand Down
11 changes: 4 additions & 7 deletions .github/instructions/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,16 @@
file_type: "index"
title: ".github Instructions Boundary"
description: "Repo-local index for instructions that remain under the .github control-plane boundary."
version: "v0.2.0"
last_updated: "2026-05-20"
version: "v0.2.1"
last_updated: "2026-05-28"
maintainer: "LightSpeed Team"
authors: ["Codex"]
license: "GPL-3.0"
tags: ["instructions", "github-boundary", "ai-ops"]
owners: ["LightSpeed Team"]
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot May 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

To ensure contributors can follow the migration rules mentioned in this README, please document the migration maps and notes in a central '/docs/MIGRATION.md' file.

References
  1. Document migration maps and notes in a central '/docs/MIGRATION.md' file to ensure contributors can follow migration rules mentioned in README files across the repository.

domain: "governance"
stability: "draft"
references:
- path: "../../instructions/README.md"
description: "Portable instruction library index."
- path: "../projects/active/portable-ai-plugin-restructure/issues/children/batch-02-portable-migration/02-03-refactor-migrate-portable-instructions.md"
description: "Issue #295 local source draft."
status: "active"
---

# .github Instructions Boundary
Expand Down
20 changes: 6 additions & 14 deletions .github/metrics/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,16 @@
---
title: "LightSpeed Metrics Directory"
version: "v1.0"
last_updated: "2025-12-04"
version: "v1.1"
last_updated: "2026-05-28"
author: "LightSpeed"
maintainer: "Ash Shaw"
description: "Metrics collection scripts, configuration, and automation for tracking repository health, documentation quality, and project activity."
tags: ["metrics", "analytics", "automation", "monitoring", "quality"]
file_type: "documentation"
category: "infrastructure"
references:
- path: "../reports/README.md"
description: "Reporting documentation"
- path: "../agents/metrics.agent.md"
description: "Metrics agent configuration"
- path: "../../docs/BRANDING.md"
description: "Branding guidelines"
- path: "../workflows/branding.yml"
description: "Branding workflow"
- path: "../workflows/metrics.yml"
description: "Issue metrics workflow"
owners: ["LightSpeed Team"]
domain: "governance"
stability: "stable"
status: "active"
---

# LightSpeed Metrics Directory
Expand Down
11 changes: 4 additions & 7 deletions .github/schemas/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,16 @@
file_type: "index"
title: ".github Schemas Boundary"
description: "Repo-local index for schemas that remain under the .github control-plane boundary."
version: "v0.2.0"
last_updated: "2026-05-20"
version: "v0.2.1"
last_updated: "2026-05-28"
maintainer: "LightSpeed Team"
authors: ["Codex"]
license: "GPL-3.0"
tags: ["schemas", "github-boundary", "ai-ops"]
owners: ["LightSpeed Team"]
domain: "governance"
stability: "draft"
references:
- path: "../../.schemas/README.md"
description: "Portable schema library index."
- path: "../projects/active/portable-ai-plugin-restructure/issues/children/batch-02-portable-migration/02-05-refactor-move-active-schemas-to-root-schemas.md"
description: "Issue #297 local source draft."
status: "active"
---

# .github Schemas Boundary
Expand Down
19 changes: 19 additions & 0 deletions .lycheeignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# URLs excluded from lychee link checking

# Social platforms that block automated HTTP clients
https://twitter.com
https://x.com
https://www.linkedin.com

# LightSpeed organisation websites — external, may have transient availability
# issues or redirect chains that lychee cannot follow in CI
https://lightspeedwp.agency
https://lsx.design
https://lightspeedwp.github.io
https://www.lsdev.biz

# Auto-generated readme-regen footer — points to a private/inaccessible repo
https://github.com/lightspeedwp/lsx-demo-theme

# External licence URL occasionally times out in CI link checks
https://www.gnu.org/licenses/gpl-3.0
13 changes: 4 additions & 9 deletions .schemas/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,16 @@
file_type: "index"
title: "Portable Schemas"
description: "Ownership index for portable schemas used by LightSpeed AI assets and plugin metadata."
version: "v0.1.1"
last_updated: "2026-05-26"
version: "v0.1.2"
last_updated: "2026-05-28"
maintainer: "LightSpeed Team"
authors: ["Codex"]
license: "GPL-3.0"
tags: ["schemas", "ai-ops", "plugin-restructure"]
owners: ["LightSpeed Team"]
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot May 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

To ensure contributors can follow the migration rules mentioned in this README, please document the migration maps and notes in a central '/docs/MIGRATION.md' file.

References
  1. Document migration maps and notes in a central '/docs/MIGRATION.md' file to ensure contributors can follow migration rules mentioned in README files across the repository.

domain: "governance"
stability: "active"
references:
- path: "../.github/projects/archived/portable-ai-plugin-restructure/portable-ai-plugin-restructure-prd-2026-05-14.md"
description: "Portable AI plugin restructure PRD."
- path: "../.github/projects/archived/portable-ai-plugin-restructure/issues/children/batch-01-skeleton-boundary/01-02-document-folder-ownership-indexes.md"
description: "Issue #290 local source draft."
- path: "../.github/projects/archived/portable-ai-plugin-restructure/issues/children/batch-02-portable-migration/02-05-refactor-move-active-schemas-to-root-schemas.md"
description: "Issue #297 local source draft."
status: "active"
---

# Portable Schemas
Expand Down
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Fixed

- Removed prohibited `references:` frontmatter field from 9 README files (`README.md`, `.github/README.md`, `.github/agents/README.md`, `.github/instructions/README.md`, `.github/metrics/README.md`, `.github/schemas/README.md`, `.schemas/README.md`, `profile/README.md`, `scripts/README.md`) per CLAUDE.md governance rule. Added missing required frontmatter fields (`owners`, `status`, `stability`, `domain`) to affected files. Removed 13 duplicate footer blocks from root `README.md`. Related to [#18](https://github.com/lightspeedwp/.github/issues/18). ([#527](https://github.com/lightspeedwp/.github/pull/527))
- Replaced deprecated MCP tool references (`create_issue`, `update_issue`, `get_issue`) with current equivalents (`issue_write`, `issue_read`) across agent specs and prompt files. Closes [#52](https://github.com/lightspeedwp/.github/issues/52). ([#455](https://github.com/lightspeedwp/.github/pull/455))
- Expanded issue template DoD checklists with discrete accessibility (WCAG 2.2 AA), security (OWASP Top 10), and performance items, aligning issue templates with the PR template. Closes [#21](https://github.com/lightspeedwp/.github/issues/21). ([#460](https://github.com/lightspeedwp/.github/pull/460))
- Updated `.coderabbit.yml`: corrected schema URL to `docs.coderabbit.ai/schema/schema.v2.json`; added `language: en-GB`, `inheritance: true`, `chat.auto_reply: true`; added `reviews.profile: chill` and `reviews.review_details: true`; hardened workflow path instructions with security guidance (least-privilege permissions, secret injection prevention, action pinning); added `instructions/**` and `CHANGELOG.md` path instructions; expanded path filters. Closes [#23](https://github.com/lightspeedwp/.github/issues/23).
Expand Down
Loading
Loading