Skip to content

docs: align README and roadmap with shipped functionality - #14

Merged
HecFranco merged 1 commit into
mainfrom
docs/readme-roadmap-sync
Aug 17, 2026
Merged

docs: align README and roadmap with shipped functionality#14
HecFranco merged 1 commit into
mainfrom
docs/readme-roadmap-sync

Conversation

@HecFranco

@HecFranco HecFranco commented Aug 17, 2026

Copy link
Copy Markdown
Contributor

Summary

Stop recommending abandoned CodeReviewGuardian; mark implementation phases that already shipped.

Test plan

  • README / roadmap match the current tag and CLI surface
  • No unrelated test or source changes in this PR

Summary by CodeRabbit

  • Documentation
    • Updated installation guidance to recommend PHP Quality Tools.
    • Added a notice that Code Review Guardian is abandoned and should not be used for new projects.
    • Updated the implementation roadmap to reflect shipped Phase 1 and most of Phase 2 features in version 2.0.34.
    • Clarified that batch optimization and future conflict-analysis work remain open, and that the historical timeline is not scheduled.

Keep the public docs in sync with the current tag: features, CLI commands, and roadmap status that were behind the code.
@coderabbitai

coderabbitai Bot commented Aug 17, 2026

Copy link
Copy Markdown

Review Change Stack

Important

Review skipped

No new commits to review since the last review.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: dd59d2a2-e789-4829-bc7c-0b2603c5be90

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: b7192ee6-3437-42d1-89ef-f4ae2c06ed01

📥 Commits

Reviewing files that changed from the base of the PR and between 1df05b1 and ed602b1.

📒 Files selected for processing (2)
  • README.md
  • docs/IMPLEMENTATION_ROADMAP.md

Included review availability: Your plan includes up to 1 review per rolling hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The README now documents PHP Quality Tools and identifies Code Review Guardian as abandoned. The implementation roadmap records the v2.0.34 status and clarifies that its timeline is historical.

Changes

Documentation updates

Layer / File(s) Summary
Align project documentation
README.md, docs/IMPLEMENTATION_ROADMAP.md
The README replaces the Code Review Guardian recommendation with PHP Quality Tools guidance. The roadmap records shipped and remaining implementation work and marks the historical timeline as non-scheduled.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Merge Risk: ⚪ Minimal · up to ed602

This documentation-only change aligns the README and roadmap with shipped functionality; no actionable merge-blocking risk remains after normal checks.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the README and roadmap updates to reflect shipped functionality.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-roadmap-sync

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.

@github-actions

Copy link
Copy Markdown

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Aug 17, 2026

Copy link
Copy Markdown
⚠️ Action not completed

Already reviewed.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@HecFranco
HecFranco merged commit b4e484a into main Aug 17, 2026
20 checks passed
@HecFranco
HecFranco deleted the docs/readme-roadmap-sync branch August 17, 2026 21:15
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