chore: finalize portable AI plugin restructure closeout#415
Conversation
|
Warning Review limit reached
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 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 configurationConfiguration used: Path: .coderabbit.yml Review profile: CHILL Plan: Pro Run ID: ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (4)
Note
|
| 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 | 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.
Comment @coderabbitai help to get the list of available commands and usage tips.
There was a problem hiding this comment.
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.
| 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`. |
There was a problem hiding this comment.
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.
| 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/. |
| - **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. |
There was a problem hiding this comment.
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.
| - **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. |
| - path: "portable-ai-plugin-restructure-migration-map-2026-05-15.csv" | ||
| description: "Canonical migration decision map." |
There was a problem hiding this comment.
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.
| - 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
- Document migration maps and notes in a central
/docs/MIGRATION.mdfile to ensure contributors can follow migration rules mentioned in README files across the repository.
| ## 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. |
There was a problem hiding this comment.
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
- Document migration maps and notes in a central
/docs/MIGRATION.mdfile to ensure contributors can follow migration rules mentioned in README files across the repository.
…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
🔍 Reviewer Summary for PR #415CI Status: ❌ Recommendations
|
There was a problem hiding this comment.
💡 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".
| `.github/README.md` guidance no longer points maintainers to `GEMINI.md`, | ||
| `CLAUDE.md`, `chatmodes`, `collections`, `.github/automation/*`, or the old | ||
| hyphenated Husky document path. |
There was a problem hiding this comment.
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 👍 / 👎.
Summary
Validation
Notes
Summary by CodeRabbit
Release Notes
Documentation
Chores