Skip to content

Revise project status and AI assistant guidance#137

Closed
umair-ably wants to merge 2 commits intomainfrom
updateReadme
Closed

Revise project status and AI assistant guidance#137
umair-ably wants to merge 2 commits intomainfrom
updateReadme

Conversation

@umair-ably
Copy link
Contributor

@umair-ably umair-ably commented Feb 25, 2026

SEE #138 INSTEAD

Updated notes regarding project status and AI assistant instructions.


Note

Low Risk
Documentation-only changes that don’t affect runtime behavior; primary risk is broken/incorrect links in the README.

Overview
Updates README.md messaging to clarify project maturity: removes the top-level beta note and adds a Public Preview note under CLI Usage with an explicit feedback/issue link.

Refreshes contributor guidance for AI tools by replacing the AI_START_HERE.md reference with AI-Assistance.mdc in .cursor/rules, and cleans up the README TOC accordingly.

Written by Cursor Bugbot for commit daa0123. This will update automatically on new commits. Configure here.

Summary by CodeRabbit

  • Documentation
    • Added a Public Preview notice for the Ably CLI to inform users about its current status and encourage issue reporting.
    • Updated documentation links to reference the new AI-Assistance.md location.
    • Restructured README sections for improved clarity and organization.

Updated notes regarding project status and AI assistant instructions.
@vercel
Copy link

vercel bot commented Feb 25, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
cli-web-cli Ready Ready Preview, Comment Feb 25, 2026 6:37am

Request Review

@coderabbitai
Copy link

coderabbitai bot commented Feb 25, 2026

Walkthrough

README.md was restructured to reorganize messaging and update documentation references. A public preview notice was added to the CLI usage section, a top-level inline note was removed, and references to AI guidance documentation were updated from AI_START_HERE.md to AI-Assistance.md.

Changes

Cohort / File(s) Summary
README Documentation Updates
README.md
Removed top-level inline note block and added public preview notice under CLI usage section. Updated AI guidance documentation references from AI_START_HERE.md to AI-Assistance.md with corrected link paths.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 The README hops to a new beat,
With public previews now clear and neat,
Old guides fade as AI-Assistance takes flight,
Each link now points to the path that's right!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main changes: revising project status notes and updating AI assistant guidance links in the README.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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 (stacked PR)
  • 📝 Generate docstrings (commit on current branch)
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch updateReadme

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

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Line 4930: The README link text and target mismatch: the link label shows
"AI-Assistance.md" while the href points to ".cursor/rules/AI-Assistance.mdc";
update README.md so the link label and target use the same filename and
extension (e.g., change the href to ".cursor/rules/AI-Assistance.md" or change
the label to "AI-Assistance.mdc") and ensure the referenced file in
.cursor/rules/ matches that extension (rename .cursor/rules/AI-Assistance.mdc to
AI-Assistance.md or vice versa); also search README.md, docs/, and
.cursor/rules/ for other occurrences and make them consistent.

ℹ️ Review info

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

  • Jira integration is disabled

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 00a97fd and 4601ce8.

📒 Files selected for processing (1)
  • README.md

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant