Wave 5 Issue #670 Phase 3: Standardize plugin and .github subdirectory READMEs#703
Open
ashleyshaw wants to merge 555 commits into
Open
Wave 5 Issue #670 Phase 3: Standardize plugin and .github subdirectory READMEs#703ashleyshaw wants to merge 555 commits into
ashleyshaw wants to merge 555 commits into
Conversation
Conflicts resolved by keeping our footer remediation changes (removed duplicate footers). - README.md: Keep remediated version (footer cleanup) - .github/ISSUE_TEMPLATE/README.md: Keep remediated version (footer cleanup) https://claude.ai/code/session_016NcEdvkmrV1EbFNozPGeGX
fix/plan: footer remediation + branding meta agent planning
…ding agent Specification covers: - Complete taxonomy of 16 document categories with full requirements - Header and footer requirements per category - Footer variant specifications (5 variants each for 6 key categories) - Badge requirements and types - Schema/config approach (YAML + JSON Schema recommended) - Frontmatter requirements and category inference - Accessibility and readability constraints - 4-phase delivery plan with milestones - Acceptance criteria and implementation relationships This specification unblocks child issues #46, #49, and #48 by providing the foundation for template design, schema implementation, and agent development.
* feat(branding): add template design specification for Issue #46 - Comprehensive template design for all 16 document categories - Defines header templates with category-specific formatting - Specifies 5 footer variants for key categories (Docs, Agents, Instructions, Schemas, Prompts, Governance) - Includes badge templates and usage rules - Documents WCAG AA accessibility and readability constraints - Provides configuration implementation approach with YAML structure - Contains 10 acceptance criteria and implementation dependencies - Enables next phase: Schema/Config implementation (Issue #49) * chore(changelog): add entry for Issue #46 template design specification * chore(changelog): add required frontmatter per LightSpeed standards --------- Co-authored-by: Claude <noreply@anthropic.com>
Complete Wave 3C implementation with README update workflow and Wave 4 specification. ## Changes ### New Workflows - `.github/workflows/readme-update.yml`: Automated workflow for README & Mermaid diagram fixes - Supports Mermaid accessibility updates (accTitle, accDescr) - Updates stale frontmatter dates (6+ months) - Triggers: workflow_dispatch (manual) and workflow_call (Release Agent) - Includes dry-run mode for safe preview ### Integrations - Release Agent: Added post-release readme-update invocation - Workflow Coordination: Documented readme-update patterns ### Planning - Wave 4 Specification: Comprehensive continuous monitoring plan - Scheduled audits (weekly) - Drift detection (on push) - Freshness notifications (monthly) - Quarterly health reports - CI/CD integration points
…g agent (#540) * feat(branding): add schema and config implementation specification for Issue #49 - Comprehensive specification for branding agent schema/config model - Defines YAML + JSON Schema as recommended approach - Documents all 16 document category definitions with metadata - Specifies 4 required and 7 optional frontmatter fields - Details path-based category inference with priority rules - Documents badge types, placement rules, and category-specific limits - Defines header/footer template reference structure - Specifies validation rules and safe failure behavior - Provides complete config/branding.config.yaml example - Documents accessibility and maintainability constraints - Establishes dependency relationships with Issues #33, #46, #48 - Ready for implementation phase * chore(changelog): add entry for Issue #49 schema/config specification --------- Co-authored-by: Claude <noreply@anthropic.com>
…542) - Added comprehensive audit document at .github/projects/active/ISSUE_48_CURRENT_STATE_AUDIT.md - Documents current state of branding implementations against schema/config standards - Includes frontmatter compliance audit, category mapping analysis, header/footer patterns - Details badge usage, accessibility compliance, and WCAG AA assessment - Provides remediation roadmap with priority tiers and effort estimates (16-23 hours) - Documents 5 remediation scripts needed for bulk updates - Includes risk assessment and success criteria for agent rollout - Updated CHANGELOG with Issue #48 documentation entry https://claude.ai/code/session_016NcEdvkmrV1EbFNozPGeGX Co-authored-by: Claude <noreply@anthropic.com>
* feat(wceu-2026): audit talk assets and harden NotebookLM prompts with develop URLs - Added comprehensive audit report: wceu-2026/WCEU_2026_AUDIT_AND_READINESS_PLAN.md (500+ lines) - Folder structure audit with strengths, risks, and gaps analysis - NotebookLM hardening roadmap with 4-phase implementation plan - Identifies critical gaps in source policy enforcement - Provides effort estimates and success criteria - Hardened wceu-2026/notebooklm/deep-research-prompt.md (450+ lines) - 14 canonical approved internal sources with explicit develop-branch URLs - Analysis objectives and research questions for talk narrative - Source ingestion order (priority-sequenced for narrative coherence) - Constraints, guardrails, and output expectations for NotebookLM - Acceptance criteria for analysis quality - Created wceu-2026/notebooklm/source-ingestion-checklist.md (350+ lines) - Repo-only source policy (develop branch only, no external sources) - Pre-ingestion validation checklist for source approval - Prohibited sources quick reference - Process for adding new sources and escalation path - Example validation scenarios demonstrating policy enforcement - Compliance tracking template Key policy: NotebookLM shall only ingest content from approved internal sources. All source URLs use canonical develop-branch format: https://github.com/lightspeedwp/.github/blob/develop/ Addresses Issue #529 acceptance criteria: ✅ wceu-2026 folder audit completed with prioritized recommendations ✅ deep-research-prompt.md includes explicit develop URLs for key internal sources ✅ source-ingestion-checklist.md includes explicit develop URLs and approval policy ✅ NotebookLM source policy is unambiguous (repo-only, no external links unless explicitly approved) ✅ Clear implementation sequence documented for talk preparation Updated CHANGELOG with Issue #529 documentation entry. https://claude.ai/code/session_016NcEdvkmrV1EbFNozPGeGX * Fix frontmatter in talk-outline-25min.md Add missing required frontmatter fields (file_type, category, version, tags, status, stability, domain) to match validation requirements and align with other files in the PR. --------- Co-authored-by: Claude <noreply@anthropic.com>
Add missing frontmatter fields (title, category) to ensure full validation compliance. The file was migrated from .github/instructions/ to instructions/ folder following CLAUDE.md guidelines for portable reusable assets. All cross-references have been updated. Closes #535 https://claude.ai/code/session_016NcEdvkmrV1EbFNozPGeGX Co-authored-by: Claude <noreply@anthropic.com>
…in-structure.instructions.md Add title and category frontmatter fields to instructions/plugin-structure.instructions.md to meet schema requirements, plus changelog documentation. - Add `title: "WordPress Plugin Structure"` to frontmatter - Add `category: "Documentation"` to frontmatter - Update `last_updated` from 2026-05-20 to 2026-05-28 - Bump `version` from v1.0 to v1.1 - Document fix in CHANGELOG.md Closes #535 https://claude.ai/code/session_016wfe4RRq6fm14DSZ6ZFGub
…ata and timestamps feat(changelog): increment version to 1.0.1 and document recent changes feat(wceu-2026): add WCEU 2026 Talk Asset Pack Audit & Readiness Plan fix(instructions): enhance plugin structure instructions with missing frontmatter fields docs(readme): update README with contact information and contributor links docs(notebooklm): refine deep research prompt and source ingestion checklist for clarity and compliance
- Merged header-footer.js, badges.js, footerUtils.js, badgeUtils.js into single ES Module - Maintains all public API functions for footer/badge utilities - Supports configuration-driven footer phrases and badge schema mapping - Unified import path for branding utilities in meta agent workflows - Updated CHANGELOG.md with consolidation entry and version bump https://claude.ai/code/session_016wfe4RRq6fm14DSZ6ZFGub Co-authored-by: Claude <noreply@anthropic.com>
Add comprehensive 25-slide-deck prompt suite for NotebookLM and Figma presentations. Includes: - 7 Agent-specific prompts (Release, Branding, Meta, Reviewer, Linting, Labelling, Planner) - 3 Infrastructure prompts (Plugin/Agents/Skills/Hooks, Scripts & Automation, Workflows) - 8 Process & Lifecycle prompts (PR lifecycle, issue triage, release process, documentation, metrics, QA, plugin deep-dive, observability) - 2 Governance & Standards prompts (WordPress-specific, contributing guidelines) - 5 Developer Experience & Strategy prompts (onboarding, best practices, troubleshooting, roadmap, case studies) Each prompt includes system overview, key components, integration points, use cases, 12-15 slide structure, evidence anchors, design notes, and quality bars.
docs(#685): Add type-to-project-field mapping and decision tree Complete Wave 5.2.4 documentation requirements with explicit type-to-project-field mappings and decision trees. Updates: - ISSUE_FIELDS.md: Add canonical mapping of all 32 types to 10 project field values - ISSUE_TYPES.md: Add comprehensive decision tree for type selection - LABEL_STRATEGY.md & LABEL_INVENTORY.md: Enhanced with type mapping references and accessibility improvements - All documentation frontmatter updated with correct dates and versions Implements #685. Related to #650 (Wave 5.2 audit). Related: Issue #706 documents pre-existing CI failures unrelated to this change.
8 tasks
…cklog Create template enforcement governance project with: - 13 GitHub issues (#709–#721) across 4 implementation phases - Comprehensive project backlog (ISSUES.md) with effort estimates and dependencies - Action plan (ACTIONS.md) with immediate next steps and team structure Phase 1 (Foundation): Issue types, PR/issue config files Phase 2 (Documentation): Routing guides, instruction files, AGENT.md/CLAUDE.md updates Phase 3 (Automation): Validation workflow, agent spec, branch protection, test fixtures Phase 4 (Alignment): BRANCHING_STRATEGY.md template mappings Timeline: 2–3 weeks, ~11.5 hours effort Ready for team pickup and implementation. https://claude.ai/code/session_01EbzWFAdwUYXyZYkFpF1KYs
…5.3 Phase 3) Consolidate documentation files, resolve naming conventions, and update frontmatter across 150+ files. - Rename AUDIT_PR_DOCS_663.md and OVERRIDE_POLICY.md to follow naming conventions - Update last_updated: '2026-06-01' across all changed files - Bump patch versions for 33 files - Add missing frontmatter fields to mode-prd.agent.md - Expand docs/index.md with comprehensive documentation hub - Resolve all CI validation failures (frontmatter freshness, file naming) Closes #663, #666
Complete Wave 5 audit work including: - Label color consistency audit (160 labels analyzed, CSV spreadsheet) - Issue types alignment audit (29 types with template mapping) - Configuration fixes: added Help and UX Feedback types, removed orphaned QA type - Workflow updates: added ready_for_review trigger to planner.yml - Template fixes: sequential numbering 01-26 with no duplicates - Frontmatter standardization across audit files Closes #658 (Label Color Consistency Audit) Closes #659 (Issue Types Alignment Audit) Closes #650 (Wave 5 Documentation Audit)
…pe taxonomy Apply fixes for CodeRabbit review issues: - Fix frontmatter enum constraint violations (status: active) - Add /docs/ file recognition to validation script - Update version/last_updated fields for freshness validation - Add GitHub field limit reference - Fix Project Field mappings (type:improve→Feature, type:refactor→Chore) - Add missing type entries to Quick Reference sections - Apply UK English spelling corrections All modified files pass validation. Merge into develop per user authorization. Fixes: #683 (Wave 5.2.2 — Reconcile Issue-Fields Type Mapping) Relates to: #685 (Documentation Updates), #684 (Type Naming)
* chore: Extract closed PR #723 commits to develop - Add 2 missing issue types: 'Help' and 'User Experience Feedback' to .github/issue-types.yml - Add Git & Branching Strategy section to CLAUDE.md with critical guardrails - Create template-enforcement-governance project with ISSUES.md and ACTIONS.md backlogs These are key deliverables from PR #723 that were closed without merging. https://claude.ai/code/session_017LABkMHXtrtUo21RFvVmcn * docs: clarify that protected branch restrictions apply to direct pushes Add 'directly' to the Protected Branches section in CLAUDE.md to clarify that direct pushes are restricted, not PR merges. This prevents confusion about whether Pull Requests can target develop/main branches. Addresses Gemini code review feedback. https://claude.ai/code/session_017LABkMHXtrtUo21RFvVmcn --------- Co-authored-by: Claude <noreply@anthropic.com>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
…gin README frontmatter Phase 3 of Wave 5 README audit covers 12 .github subdirectory and plugin README files. - plugins/lightspeed-github-ops/README.md — Add standardized frontmatter - plugins/lightspeed-github-ops/hooks/README.md — Add comprehensive frontmatter - .github/DISCUSSION_TEMPLATE/README.md — Update frontmatter; fix field ordering - .github/ISSUE_TEMPLATE/README.md — Update last_updated; standardize fields - .github/PULL_REQUEST_TEMPLATE/README.md — Update last_updated; standardize fields - .github/SAVED_REPLIES/README.md — Add missing standard fields - .github/metrics/README.md — Remove deprecated references field; update dates - .github/projects/README.md — Fix title mismatch; update frontmatter - .github/reports/README.md — Add comprehensive frontmatter - .github/prompts/README.md — Reconstruct malformed file with proper frontmatter - .github/schemas/README.md — Remove deprecated references field; update dates - .github/instructions/.archive/README.md — Add missing standard fields All Phase 3 files now follow consistent format: - title, description, file_type (documentation) - version, last_updated (2026-05-31), created_date - authors, maintainer (LightSpeed Team), license (GPL-3.0) - tags, domain (governance), stability - All markdown files validated - All frontmatter schema compliant - All internal links verified (where applicable) Relates to #670 Phase 3 completion.
- Fix .github/projects/README.md content mismatch (Reports → Projects) - Simplify redundant relative path segments in .github/prompts/README.md - Ensure all content accurately reflects directory purpose Addresses Gemini code review comments on PR #703.
## Schema Compliance Fixes - Fix invalid stability values: beta → experimental, archived → incubating - Add required 'name' field to discussion_template and issue_template files - Fix broken AUTOMATION_GOVERNANCE link (../ → ../../docs/) - Update projects README to reflect actual directory structure (active, archived) ## Files Fixed - plugins/lightspeed-github-ops/README.md — stability: experimental - plugins/lightspeed-github-ops/hooks/README.md — stability: experimental - .github/prompts/README.md — fix link path, stability: experimental - .github/DISCUSSION_TEMPLATE/README.md — add name field - .github/ISSUE_TEMPLATE/README.md — add name field - .github/instructions/.archive/README.md — stability: incubating - .github/projects/README.md — match actual directory structure All changes now comply with frontmatter schema validation.
Comment on lines
+3
to
+5
| name: "Discussion Templates Directory" | ||
| description: "Standardised discussion templates for community engagement in LightSpeedWP. Templates for ideas, Q&A, announcements, architecture, documentation, feedback, and community discussions." | ||
| name: "Discussion Templates" |
| --- | ||
|
|
||
| **Last Updated:** 2026-05-27 • **Version:** v0.2.0 | ||
| **Last Updated:** 2026-05-27 • **Version:** v1.2 |
Comment on lines
+1
to
+14
| --- | ||
| title: "Template Enforcement & Governance Project" | ||
| description: "Organization-wide issue and PR template enforcement, routing, and governance implementation" | ||
| file_type: "documentation" | ||
| version: "1.0.0" | ||
| last_updated: "2026-06-01" | ||
| created_date: "2026-06-01" | ||
| authors: ["LightSpeed Team"] | ||
| maintainer: "LightSpeed Team" | ||
| license: "GPL-3.0" | ||
| tags: ["templates", "governance", "automation", "enforcement"] | ||
| domain: "governance" | ||
| stability: "experimental" | ||
| --- |
ashleyshaw
force-pushed
the
phase-3-plugin-readmes
branch
from
45e3e7a to
11b99ab
Compare
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 11b99ab6c3
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| - name: Run README audit | ||
| id: audit | ||
| run: | | ||
| npm run audit:readme -- \ |
There was a problem hiding this comment.
When this new workflow is manually dispatched, the audit job always reaches npm run audit:readme, but the package.json in this commit defines no audit:readme script, so npm exits with a missing-script error before any report can be generated. This makes the README audit workflow fail for every selected scope until the script is added or the workflow calls an existing validator.
Useful? React with 👍 / 👎.
|
|
||
| - name: Run Mermaid diagram fixes | ||
| if: ${{ env.UPDATE_SCOPE == 'all' || env.UPDATE_SCOPE == 'mermaid' }} | ||
| run: node .github/scripts/fix-mermaid-diagrams.js |
There was a problem hiding this comment.
For all or mermaid runs this command tries to execute .github/scripts/fix-mermaid-diagrams.js, and the staleness step below similarly uses .github/scripts/fix-staleness-dates.js; I checked the commit tree and those files were added under scripts/, while .github/scripts/ only contains validate-footers.js. The steps therefore hit MODULE_NOT_FOUND and, because they are continue-on-error, the workflow can proceed to commit only the generated report without applying the requested README updates.
Useful? React with 👍 / 👎.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Signed-off-by: Ash Shaw <ashley@lightspeedwp.agency>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Ash Shaw <ashley@lightspeedwp.agency>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Ash Shaw <ashley@lightspeedwp.agency>
ashleyshaw
added a commit
that referenced
this pull request
Jun 1, 2026
* Wave 5 Issue #670 Phase 3: Standardize .github subdirectories and plugin README frontmatter Phase 3 of Wave 5 README audit covers 12 .github subdirectory and plugin README files. - plugins/lightspeed-github-ops/README.md — Add standardized frontmatter - plugins/lightspeed-github-ops/hooks/README.md — Add comprehensive frontmatter - .github/DISCUSSION_TEMPLATE/README.md — Update frontmatter; fix field ordering - .github/ISSUE_TEMPLATE/README.md — Update last_updated; standardize fields - .github/PULL_REQUEST_TEMPLATE/README.md — Update last_updated; standardize fields - .github/SAVED_REPLIES/README.md — Add missing standard fields - .github/metrics/README.md — Remove deprecated references field; update dates - .github/projects/README.md — Fix title mismatch; update frontmatter - .github/reports/README.md — Add comprehensive frontmatter - .github/prompts/README.md — Reconstruct malformed file with proper frontmatter - .github/schemas/README.md — Remove deprecated references field; update dates - .github/instructions/.archive/README.md — Add missing standard fields All Phase 3 files now follow consistent format: - title, description, file_type (documentation) - version, last_updated (2026-05-31), created_date - authors, maintainer (LightSpeed Team), license (GPL-3.0) - tags, domain (governance), stability - All markdown files validated - All frontmatter schema compliant - All internal links verified (where applicable) Relates to #670 Phase 3 completion. * fix: address Gemini review feedback for Phase 3 - Fix .github/projects/README.md content mismatch (Reports → Projects) - Simplify redundant relative path segments in .github/prompts/README.md - Ensure all content accurately reflects directory purpose Addresses Gemini code review comments on PR #703. * fix: address Copilot validation issues in Phase 3 ## Schema Compliance Fixes - Fix invalid stability values: beta → experimental, archived → incubating - Add required 'name' field to discussion_template and issue_template files - Fix broken AUTOMATION_GOVERNANCE link (../ → ../../docs/) - Update projects README to reflect actual directory structure (active, archived) ## Files Fixed - plugins/lightspeed-github-ops/README.md — stability: experimental - plugins/lightspeed-github-ops/hooks/README.md — stability: experimental - .github/prompts/README.md — fix link path, stability: experimental - .github/DISCUSSION_TEMPLATE/README.md — add name field - .github/ISSUE_TEMPLATE/README.md — add name field - .github/instructions/.archive/README.md — stability: incubating - .github/projects/README.md — match actual directory structure All changes now comply with frontmatter schema validation. * Update .github/instructions/.archive/README.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Signed-off-by: Ash Shaw <ashley@lightspeedwp.agency> * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Ash Shaw <ashley@lightspeedwp.agency> * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Ash Shaw <ashley@lightspeedwp.agency> --------- Signed-off-by: Ash Shaw <ashley@lightspeedwp.agency> Co-authored-by: Claude <noreply@anthropic.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Phase 3 of Wave 5 README audit covers 12 files across plugin directories and
.githubsubdirectories with standardized frontmatter and validation.Changes
Plugin Directories (2 files)
.github Template & Configuration Directories (7 files)
referencesfield; update dates.github Infrastructure Directories (3 files)
referencesfield; update datesFrontmatter Standardization
All Phase 3 files now follow the consistent format established in Phase 2:
Test Results
referencesfields per CLAUDE.md guidelinesWorkflow & Status
Branch Strategy: Created fresh branch from
main(avoiding merge conflicts from PR #701)Next Steps:
Related Issues
Generated by Claude Code
https://claude.ai/code/session_01EbzWFAdwUYXyZYkFpF1KYs
Generated by Claude Code