Skip to content

Conversation

@TabishB
Copy link
Contributor

@TabishB TabishB commented Jan 28, 2026

Motivation

  • The migration guide referenced an incorrect CLI invocation for listing schemas; the correct command is openspec schemas rather than openspec workflow schemas.

Description

  • Updated docs/migration-guide.md to replace openspec workflow schemas with openspec schemas and to replace openspec workflow schemas --json with openspec schemas --json.

Testing

  • Docs-only change; no automated tests were run and no runtime code paths were modified.

Codex Task

Summary by CodeRabbit

  • Documentation
    • Updated migration guide with corrected CLI command syntax for schema listing operations, ensuring users have accurate reference information for schema management tasks.

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

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 28, 2026

📝 Walkthrough

Walkthrough

Documentation updates in the migration guide that correct CLI command examples from "openspec workflow schemas" to "openspec schemas" across two locations, reflecting the current command syntax without affecting underlying functionality.

Changes

Cohort / File(s) Summary
Documentation Updates
docs/migration-guide.md
Updated CLI command references from openspec workflow schemas to openspec schemas in two locations

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • PR #445: Updates CLI usage text to leverage the "openspec schemas" alias, aligning with the new command export documented here
  • PR #582: Related documentation update that also standardizes openspec schema CLI command usage across docs

Poem

🐰 A rabbit hopped through the migration guide,
With a quick pen stroke, corrected with pride!
"Workflow schemas?" No, that's old hat—
"Just openspec schemas!" (Much cleaner than that)
✨ Commands aligned, docs now shine bright!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: fixing an incorrect CLI command in the migration guide documentation.
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.

@greptile-apps
Copy link

greptile-apps bot commented Jan 28, 2026

Greptile Overview

Greptile Summary

Updated migration guide to correct CLI command references from openspec workflow schemas to openspec schemas.

  • Fixed command in "Available Schemas" section (line 469)
  • Fixed command with --json flag in "Troubleshooting" section (line 513)

Both commands now match the actual CLI implementation which registers schemas as a top-level command, not a subcommand of workflow.

Confidence Score: 5/5

  • This PR is safe to merge with no risk
  • Documentation-only change that corrects two CLI command references to match the actual implementation. Verified against the codebase that openspec schemas is the correct command.
  • No files require special attention

Sequence Diagram

sequenceDiagram
    participant User
    participant CLI as OpenSpec CLI
    participant Docs as Migration Guide
    
    User->>Docs: Read migration guide
    Note over Docs: Line 469: "openspec schemas"
    User->>CLI: Execute: openspec schemas
    CLI->>CLI: schemasCommand()
    CLI-->>User: Display available schemas
    
    Note over User,CLI: Second example
    User->>Docs: Read troubleshooting section
    Note over Docs: Line 513: "openspec schemas --json"
    User->>CLI: Execute: openspec schemas --json
    CLI->>CLI: schemasCommand({json: true})
    CLI-->>User: Return JSON artifact IDs
Loading

@TabishB TabishB merged commit 4130575 into main Jan 28, 2026
10 checks passed
@TabishB TabishB deleted the codex/fix-schema-listing-command-in-docs branch January 28, 2026 03:59
@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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants