Skip to content

Conversation

@Haven-S
Copy link

@Haven-S Haven-S commented Jan 29, 2026

Congrats on shipping v1.0!

Noticed opsx.md hadn't been updated yet, so here's a refresh:

  • Made it clear OPSX is now the default way to use OpenSpec
  • Renamed "Standard workflow" to "Legacy workflow" (less confusing)
  • Removed Claude Code-only note - OPSX is now widely applied
  • Cleaned up deprecated openspec experimental command

Summary by CodeRabbit

  • Documentation
    • Updated OPSX documentation to clarify OPSX as the standard workflow, with legacy terminology for the prior approach.
    • Reorganized architecture and setup sections with updated examples and clearer terminology.
    • Refreshed diagrams and tables to reflect current OPSX paradigm and workflow distinctions.

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

@Haven-S Haven-S requested a review from TabishB as a code owner January 29, 2026 16:15
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 29, 2026

📝 Walkthrough

Walkthrough

This pull request updates the OPSX workflow documentation to reposition OPSX as the primary paradigm and rename the previous "standard workflow" to "legacy" workflow. Content is reorganized, sections and headings are revised for consistency, and setup instructions are clarified to reflect automatic skill generation.

Changes

Cohort / File(s) Summary
Documentation Restructuring
docs/opsx.md
Rebranded workflow terminology (standard→legacy, experimental→OPSX), reorganized "What Is It?" section, updated architecture/deep-dive sections, revised setup steps and configuration examples, and aligned all tables and prose to reflect the new OPSX paradigm emphasis.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

Suggested labels

codex

Poem

🐰 The legacy rests while OPSX takes flight,
Documents reborn in clarity's light,
Schemas dance freely, no rigid confines—
Workflows evolve through iterative lines,
A rabbit approves this semantic delight! ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'docs: modernize opsx.md' is vague and generic, using 'modernize' which doesn't convey specific information about the substantive changes made to the document. Consider a more specific title like 'docs: update opsx.md to reflect v1.0 with OPSX as default workflow' that clearly describes the main changes.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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


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.

@vibe-kanban-cloud
Copy link

Review Complete

Your review story is ready!

View Story

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

@greptile-apps
Copy link

greptile-apps bot commented Jan 29, 2026

Greptile Overview

Greptile Summary

This PR modernizes docs/opsx.md to reflect that OPSX is now the standard OpenSpec workflow.

Key changes:

  • Removed "Claude Code only" compatibility notice — OPSX is now widely available across AI coding assistants
  • Renamed "Standard workflow" to "Legacy workflow" throughout the document for clarity
  • Removed deprecated openspec experimental command from setup instructions
  • Updated config creation reference from experimental to openspec init
  • Clarified that skills are "automatically generated" during init

All changes are consistent with the codebase — the openspec experimental command was indeed deprecated and merged into openspec init (src/cli/index.ts:132-150).

Confidence Score: 5/5

  • This PR is safe to merge — it's a straightforward documentation update with no code changes
  • All changes are accurate and consistent with the current codebase. The deprecated command has been properly removed, terminology has been clarified, and the documentation correctly reflects the current state of OPSX.
  • No files require special attention

Important Files Changed

Filename Overview
docs/opsx.md Terminology update: replaced "Standard workflow" with "Legacy workflow" and updated references to deprecated commands

Sequence Diagram

sequenceDiagram
    participant User
    participant Doc as docs/opsx.md
    participant CLI as OpenSpec CLI
    
    Note over User,CLI: Documentation Modernization
    
    User->>Doc: Remove "Claude Code only" notice
    Note right of Doc: OPSX now widely available
    
    User->>Doc: Update "Standard workflow" → "Legacy workflow"
    Note right of Doc: Clarifies terminology
    
    User->>Doc: Update setup instructions
    User->>Doc: Remove "openspec experimental" command
    Note right of Doc: Command deprecated, merged into init
    
    User->>Doc: Update "Config is created during experimental"
    User->>Doc: Change to "Config is created during openspec init"
    Note right of Doc: Reflects current CLI behavior
    
    User->>CLI: openspec init
    Note right of CLI: Now handles all setup (including skills)
    CLI-->>User: Skills auto-generated in .claude/skills/
Loading

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