Skip to content

chore: finalize portable AI plugin restructure closeout#415

Merged
ashleyshaw merged 2 commits into
developfrom
codex/portable-ai-plugin-restructure-closeout
May 26, 2026
Merged

chore: finalize portable AI plugin restructure closeout#415
ashleyshaw merged 2 commits into
developfrom
codex/portable-ai-plugin-restructure-closeout

Conversation

@ashleyshaw
Copy link
Copy Markdown
Member

@ashleyshaw ashleyshaw commented May 26, 2026

Summary

Validation

  • npx markdownlint-cli2 (targeted docs)
  • npm run validate:structure
  • npm run validate:json:schemas
  • npm run validate:agents
  • git diff --check

Notes

Summary by CodeRabbit

Release Notes

  • Documentation

    • Reorganized repository documentation with improved ownership, governance, and structure guidance across all major folders
    • Refined onboarding instructions and component integration details in main README
    • Added portable workflow documentation and execution runbook for AI plugin restructuring
  • Chores

    • Updated project inventory and migration status reports with current reconciliation data and asset classifications

Review Change Stack

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 26, 2026

Warning

Review limit reached

@ashleyshaw, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 54 minutes and 38 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro

Run ID: 1a7c0cc2-57a4-4a9c-97c0-f20154a7501d

📥 Commits

Reviewing files that changed from the base of the PR and between fc6a20e and 8512413.

⛔ Files ignored due to path filters (1)
  • .github/projects/archived/portable-ai-plugin-restructure/portable-ai-plugin-restructure-migration-map-2026-05-15.csv is excluded by !**/*.csv
📒 Files selected for processing (4)
  • .github/projects/archived/portable-ai-plugin-restructure/portable-ai-plugin-restructure-inventory-report-2026-05-15.md
  • .github/projects/archived/portable-ai-plugin-restructure/portable-ai-plugin-restructure-legacy-prompts-classification-report-2026-05-26.md
  • .github/projects/archived/portable-ai-plugin-restructure/portable-ai-plugin-restructure-portable-workflows-source-report-2026-05-26.md
  • .github/projects/archived/portable-ai-plugin-restructure/portable-ai-plugin-restructure-stale-reference-cleanup-report-2026-05-19.md

Note

.coderabbit.yml has unrecognized properties

CodeRabbit is using all valid settings from your configuration. Unrecognized properties (listed below) have been ignored and may indicate typos or deprecated fields that can be removed.

⚠️ Parsing warnings (1)
Validation error: Unrecognized keys: "auto_labels", "auto_assign", "auto_review"
⚙️ Configuration instructions
  • Please see the configuration documentation for more information.
  • You can also validate your configuration using the online YAML validator.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
📝 Walkthrough

Walkthrough

This PR completes the portable AI plugin restructure initiative by standardizing folder ownership documentation, updating repository guidance, documenting a new workflow runbook, and recording completion audits across 18 Markdown files with consistent governance patterns and status updates.

Changes

Portable Restructure Documentation & Completion

Layer / File(s) Summary
Repository-level Guidance Updates
.github/README.md
Updated "Key goals," "Usage & Quickstart," directory structure, and "Component Integration Details" to reflect portable asset paths (/agents, /skills, /cookbook, /workflows), remove chat-mode/CLAUDE/GEMINI references, and clarify repo-local custom instructions and global agent rules.
Folder Ownership README Standardization
.schemas/README.md, agents/README.md, cookbook/README.md, hooks/README.md, instructions/README.md, plugins/README.md, skills/README.md, workflows/README.md
Rewrote all folder-level READMEs with consistent YAML frontmatter (file_type, status, owners, last_updated), added "Overview" and "Governance links" sections, standardized "Structure" tables, and aligned references to Issue #290 draft and migration decision map across all ownership indices.
Portable Workflow Runbook & Catalogue
workflows/portable-ai-plugin-restructure.md, workflows/README.md
Added new workflow runbook with inputs, outputs, execution steps, and guardrails; updated workflows README to introduce "Agentic Workflows" governance and link the new portable-ai-plugin-restructure workflow specification.
Restructuring Completion Audits & Status Reports
.github/projects/active/portable-ai-plugin-restructure/*
Updated inventory report (416 files, migration decision counts), added legacy prompt classification audit (10 missing-frontmatter items, P0 candidates identified), snapshot live issue status (all 40 parent/child issues #282#321 closed), defined portable workflows source boundaries, and verified stale reference cleanup (chat-mode, collections, CLAUDE/GEMINI references removed).
Schema Path Reference Update
instructions/readme.instructions.md
Updated "Repo schemas" reference from .github/schemas/ to ../.schemas/ in the subfolder README patterns section.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

  • lightspeedwp/.github#322: Both PRs operate on the "portable-ai-plugin-restructure" planning artifact set, directly updating the same inventory report and related legacy-prompt classification work.

Suggested labels

status:needs-review, documentation

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description provides a clear summary, validation steps, and notes, but is missing structured changelog entries (Added/Changed/Fixed/Removed sections), linked issues reference, and risk assessment required by the template. Add the missing template sections: fill in 'Closes #' with relevant issue numbers, complete the Changelog with entries for each section, and include Risk Assessment with level, impact, and mitigation steps.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main objective: finalizing the closeout of the portable AI plugin restructure project, which aligns with the PR's core purpose of completing artifacts and syncing status.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/portable-ai-plugin-restructure-closeout

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request cleans up git merge conflict markers across several README files in the portable AI directories (including .schemas/, agents/, cookbook/, hooks/, instructions/, plugins/, skills/, and workflows/). It also updates the main .github/README.md to reflect the new portable asset structure, adds several project reports, and introduces a new portable agentic workflow specification. The review feedback suggests standardizing directory path formatting in the main README to use backticks and relative paths, and recommends centralizing or referencing the migration maps and reports in a central /docs/MIGRATION.md file.

Comment thread .github/README.md Outdated
Comment on lines +164 to +165
2. Use portable files in `/instructions` before starting development to align with standards.
3. For AI-assisted workflows, use portable assets from `/agents`, `/skills`, `/cookbook`, and `/workflows`.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

The folder references /instructions, /agents, /skills, /cookbook, and /workflows are formatted with a leading slash and lack backticks. For consistency with other directory references in this document (e.g., .github/workflows/, SAVED_REPLIES/), and to ensure proper rendering in all markdown viewers, please use backticks and relative paths without a leading slash.

Suggested change
2. Use portable files in `/instructions` before starting development to align with standards.
3. For AI-assisted workflows, use portable assets from `/agents`, `/skills`, `/cookbook`, and `/workflows`.
2. Use portable files in instructions/ before starting development to align with standards.
3. For AI-assisted workflows, use portable assets from agents/, skills/, cookbook/, and workflows/.

Comment thread .github/README.md Outdated
Comment on lines +458 to +459
- **Prompts**: Legacy prompt templates remain under `.github/prompts/` while durable workflows are classified for `/skills` or `/cookbook`.
- **Agents**: Agent specs and rules in `AGENTS.md`, `/agents`, and `.github/custom-instructions.md` detail expected behaviour, standards, and escalation procedures for automated or AI contributors.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

The folder references /skills, /cookbook, and /agents are formatted with a leading slash and lack backticks. Please format them consistently with backticks and relative paths (e.g., skills/, cookbook/, agents/) to match the rest of the document.

Suggested change
- **Prompts**: Legacy prompt templates remain under `.github/prompts/` while durable workflows are classified for `/skills` or `/cookbook`.
- **Agents**: Agent specs and rules in `AGENTS.md`, `/agents`, and `.github/custom-instructions.md` detail expected behaviour, standards, and escalation procedures for automated or AI contributors.
- Prompts: Legacy prompt templates remain under .github/prompts/ while durable workflows are classified for skills/ or cookbook/.
- Agents: Agent specs and rules in AGENTS.md, agents/, and .github/custom-instructions.md detail expected behaviour, standards, and escalation procedures for automated or AI contributors.

Comment on lines +16 to +17
- path: "portable-ai-plugin-restructure-migration-map-2026-05-15.csv"
description: "Canonical migration decision map."
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

According to the general rules, migration maps and notes should be documented in a central /docs/MIGRATION.md file to ensure contributors can easily follow migration rules mentioned in README files across the repository. Please ensure this migration map and its classification notes are documented or referenced in /docs/MIGRATION.md.

Suggested change
- path: "portable-ai-plugin-restructure-migration-map-2026-05-15.csv"
description: "Canonical migration decision map."
- path: ../../../../docs/MIGRATION.md
description: Central migration map and notes.
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.

Comment on lines +74 to +80
## 2026-05-26 Reconciliation Note

The migration map was reconciled after later #293 classification work expanded
the inventory to include previously omitted pull request templates, discussion
templates, GitHub governance configuration, and repo-local Copilot
configuration. Committed conflict markers were removed from the canonical CSV,
and this report now reflects the active 416-row map.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

According to the general rules, migration maps and notes should be documented in a central /docs/MIGRATION.md file to ensure contributors can easily follow migration rules mentioned in README files across the repository. Please ensure the reconciled migration map and these reconciliation notes are documented or referenced in /docs/MIGRATION.md.

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.

@ashleyshaw ashleyshaw marked this pull request as ready for review May 26, 2026 20:12
…plugin-restructure-closeout

# Conflicts:
#	.github/README.md
#	.github/projects/active/portable-ai-plugin-restructure/portable-ai-plugin-restructure-live-issue-status-2026-05-26.md
#	.github/projects/archived/portable-ai-plugin-restructure/portable-ai-plugin-restructure-legacy-prompts-classification-report-2026-05-26.md
#	.github/projects/archived/portable-ai-plugin-restructure/portable-ai-plugin-restructure-portable-workflows-source-report-2026-05-26.md
#	.schemas/README.md
#	agents/README.md
#	cookbook/README.md
#	hooks/README.md
#	instructions/README.md
#	instructions/readme.instructions.md
#	plugins/README.md
#	skills/README.md
#	workflows/README.md
@ashleyshaw ashleyshaw merged commit 7a0b72b into develop May 26, 2026
@ashleyshaw ashleyshaw deleted the codex/portable-ai-plugin-restructure-closeout branch May 26, 2026 20:14
@github-actions
Copy link
Copy Markdown
Contributor

🔍 Reviewer Summary for PR #415

CI Status:pending
Files changed: 6

Recommendations

  • CI checks not green

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: fc6a20e3ff

ℹ️ 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".

Comment on lines +92 to +94
`.github/README.md` guidance no longer points maintainers to `GEMINI.md`,
`CLAUDE.md`, `chatmodes`, `collections`, `.github/automation/*`, or the old
hyphenated Husky document path.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Correct stale-reference verification statement

This verification note is inaccurate: .github/README.md still contains multiple ./automation/... links (for example ./automation/labels.yml, ./automation/labeler.yml, and ./automation/AUTOMATION_GOVERNANCE.md), so claiming those references were removed can cause issue #294 to be treated as complete while stale/broken guidance remains. Please either remove those README references or update this report to mark them as outstanding/deferred.

Useful? React with 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant