Skip to content

Conversation

@TabishB
Copy link
Contributor

@TabishB TabishB commented Jan 24, 2026

Summary

Context

The README update was part of the init/experimental merge PR, but the package hasn't been released yet. This reverts the README to prevent documenting unreleased features.

A separate PR (docs/readme-init-updates) has been opened to re-apply these changes when the package is released.

Test plan

  • README restored to previous state
  • No code changes, only documentation

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Reorganized README with updated workflow guidance and native slash-commands integration.
    • Added new Experimental Features section for advanced workflow capabilities.
    • Updated initialization and setup flow documentation.
    • Added Telemetry details section with usage data information and opt-out options.
    • Refreshed command reference and walkthrough examples.

✏️ Tip: You can customize this high-level summary in your review settings.

Reverts the README documentation changes that were included in PR #565.
These changes document features that aren't released yet.

A separate PR will be opened to re-apply these changes when the package
is released.
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 24, 2026

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

This pull request comprehensively restructures the README to shift from legacy "Agent Skills + Slash Commands" framing to "Native Slash Commands" and introduces the new "Experimental OPSX Workflow" concept. The changes update initialization setup, artifact progression examples, command references, team adoption guidance, and add new Telemetry and Experimental Features sections.

Changes

Cohort / File(s) Summary
README Documentation Restructure
README.md
Major restructuring replacing legacy workflow narrative with Native Slash Commands framework. Sections renamed (e.g., "Supported AI Tools" → "Native Slash Commands"), initialization flow updated to reflect managed AGENTS.md hand-off and openspec/ directory structure. Complete rework of "Create and manage a change" section with new artifact progression (Draft/Proposal → Verify & Review → Refine the Specs → Implement → Archive). New Experimental Features section added documenting OPSX: Fluid, Iterative Workflow. Added Telemetry section in collapsible block. Updated command reference to emphasize native commands. Example artifacts, file-tree patterns, and delta formats rewritten to align with new workflow narrative.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

Poem

🐰 Hop along, dear documentation fine,
Your sections now in perfect line,
From legacy to native command's glow,
OPSX workflows steal the show!
New telemetry, new features bright,
Your README now shines its light! ✨


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.

@TabishB TabishB merged commit 847aa81 into main Jan 24, 2026
9 of 10 checks passed
@TabishB TabishB deleted the revert/readme-premature-update branch January 24, 2026 04:06
@greptile-apps
Copy link

greptile-apps bot commented Jan 24, 2026

Greptile Summary

This PR cleanly reverts the README documentation changes introduced in PR #565, restoring the previous stable state. The changes document the OPSX workflow features and Agent Skills integration that were merged but not yet released.

Key changes reverted:

  • Removed documentation of Agent Skills + /opsx:* slash commands workflow
  • Restored the "Experimental Workflow" language instead of presenting it as the default
  • Reverted tool configuration section to show native slash commands table instead of skills-based approach
  • Restored previous openspec init workflow description (without --tools flags and legacy upgrade mentions)
  • Moved OPSX workflow back to "Experimental Features" section from main workflow

The revert is appropriate since the package hasn't been released yet. A separate branch docs/readme-init-updates exists to re-apply these changes after the release.

Confidence Score: 5/5

  • This PR is completely safe to merge - it's a clean documentation-only revert with no code changes
  • Perfect confidence score because: (1) This is a documentation-only change with zero code impact, (2) The revert is clean and returns README to a known stable state, (3) The reasoning is sound - preventing documentation of unreleased features, (4) A forward branch exists to reapply changes later, (5) No functional, security, or compatibility risks
  • No files require special attention

Important Files Changed

Filename Overview
README.md Clean revert of documentation changes from PR #565 back to previous stable state

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant PR565 as PR #565 (Merged)
    participant README as README.md
    participant PR567 as PR #567 (This PR)
    participant Branch as docs/readme-init-updates
    
    Note over PR565,README: PR #565 merges init/experimental features
    PR565->>README: Update with Agent Skills docs
    PR565->>README: Document /opsx:* commands
    PR565->>README: Update init workflow
    Note over README: README now documents unreleased features
    
    Note over Dev,PR567: Realizes package not yet released
    Dev->>PR567: Create revert PR
    PR567->>README: Revert to pre-#565 state
    Note over README: README restored to stable state
    
    Dev->>Branch: Create docs/readme-init-updates branch
    Note over Branch: Ready to reapply after release
    
    Note over PR567: Safe to merge - docs only
Loading

@vibe-kanban-cloud
Copy link

Review Complete

Your review story is ready!

View Story

Comment !reviewfast on this PR to re-generate the story.

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.

2 participants