Skip to content

docs: codex plugin README clarity and update instructions#133

Merged
tzachbon merged 4 commits intomainfrom
docs/codex-readme-clarity
Apr 8, 2026
Merged

docs: codex plugin README clarity and update instructions#133
tzachbon merged 4 commits intomainfrom
docs/codex-readme-clarity

Conversation

@tzachbon
Copy link
Copy Markdown
Owner

@tzachbon tzachbon commented Apr 8, 2026

Summary

  • Add update instructions to both root README and Codex plugin README (clone/copy workflow)
  • Add Codex CLI prerequisite callout before install steps
  • Remove "ask Codex to do it" prompt blocks from root README (stale, noisy)
  • Simplify migration bash from verbose for-loop to single glob rm
  • Remove hardcoded version from Codex plugin README (drifts from plugin.json)
  • Fix orphaned heading level and consolidate duplicate restart lines

Test Plan

  • Verify all internal markdown links resolve
  • Confirm update instructions are copy-pasteable
  • Check no hardcoded versions remain in README prose

Summary by CodeRabbit

  • Documentation

    • Updated plugin installation instructions with clearer setup procedures for personal and per-project configurations.
    • Refreshed documentation paths and migration guidance for the reorganized plugin structure.
  • Chores

    • Version bump to 4.10.1.
    • Updated internal configuration and test references for plugin reorganization.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 8, 2026

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

This pull request systematically renames and relocates the Codex plugin directory from plugins/codex to plugins/ralph-specum-codex, updating all references across configuration files, GitHub workflows, documentation, test suites, and helper scripts. The plugin version is also bumped to 4.10.1.

Changes

Cohort / File(s) Summary
Plugin Configuration
.agents/plugins/marketplace.json, plugins/ralph-specum-codex/.codex-plugin/plugin.json
Updated plugin marketplace source path from ./plugins/codex to ./plugins/ralph-specum-codex and bumped plugin version from 4.10.0 to 4.10.1.
GitHub Workflows
.github/workflows/bats-tests.yml, .github/workflows/codex-version-check.yml
Updated workflow path filters and manifest file location references from plugins/codex/** to plugins/ralph-specum-codex/** to trigger on correct plugin directory changes.
Documentation
README.md, plugins/ralph-specum-codex/README.md, plugins/ralph-specum-codex/references/path-resolution.md
Updated installation instructions, plugin paths, and code examples to reference new ralph-specum-codex directory; restructured Codex setup into collapsible sections and added Prerequisites and Quick Start guidance.
Test Files
tests/codex-platform-scripts.bats, tests/codex-platform.bats, tests/codex-plugin.bats, tests/helpers/version-sync.sh
Updated all plugin root path references in test helpers and assertions from plugins/codex to plugins/ralph-specum-codex to ensure tests validate against the relocated plugin directory.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Poem

🐰 A codex once lived in a folder so plain,
Now ralph-specum-codex it shall be named—
With paths all updated and tests set aflame,
The rabbit hops proudly through each refactored lane,
Where workflows and docs in new places now reign! 🌟

🚥 Pre-merge checks | ✅ 1 | ❌ 2

❌ Failed checks (2 warnings)

Check name Status Explanation Resolution
Title check ⚠️ Warning The PR title describes documentation improvements to README clarity and instructions, but the actual changes include a substantial structural rename of the plugin directory from 'codex' to 'ralph-specum-codex' with updates across marketplace.json, CI workflows, test files, and multiple documentation files. Update the title to reflect the primary change: 'refactor: rename codex plugin to ralph-specum-codex and update documentation' or similar, as the directory rename is a structural change affecting multiple systems beyond just documentation.
Docstring Coverage ⚠️ Warning Docstring coverage is 30.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (1 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

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

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/codex-readme-clarity

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.

@tzachbon tzachbon force-pushed the docs/codex-readme-clarity branch from 952c9ae to 0080c9d Compare April 8, 2026 11:18
tzachbon added 2 commits April 8, 2026 14:21
… instructions

- Rename plugins/codex/ to plugins/ralph-specum-codex/ to avoid confusion with OpenAI Codex CLI
- Put install steps under <details> tags (hidden by default)
- Add explicit comments explaining each step (no assumptions about current directory)
- Update all path references in READMEs, marketplace.json, and path-resolution.md
@tzachbon tzachbon merged commit 1b33202 into main Apr 8, 2026
4 of 5 checks passed
@tzachbon tzachbon deleted the docs/codex-readme-clarity branch April 8, 2026 11:35
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