docs(opsx): clarify /opsx:sync description and add usage section - #1606
Conversation
- Changed description from 'Sync delta specs to main' to 'Merge delta specs into main specs' - Added detailed Usage section for /opsx:sync command - Now consistent with commands.md and migration-guide.md - Improves documentation completeness and clarity
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThe PR updates Changes
Estimated code review effort: 1 (Trivial) | ~3 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
Deploying openspec-docs with
|
| Latest commit: |
02c5938
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://12275f78.openspec-docs.pages.dev |
| Branch Preview URL: | https://claude-pr-1061-merge-ready-3.openspec-docs.pages.dev |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/opsx.md`:
- Around line 219-221: Update the code fence containing `/opsx:sync` in the
documentation to specify the `text` language on its opening fence, resolving the
markdownlint MD040 violation.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 7dcfa899-2864-4944-9929-3d5df2c87ebe
📒 Files selected for processing (1)
docs/opsx.md
Fold the /opsx:sync usage entry into a single prose paragraph to match the six sibling Usage sections (heading -> fence -> paragraph), and fix two accuracy issues found against src/core/templates/workflows/sync-specs.ts: - Drop the invented "changes see each other's specs" and "test integration" use cases (no cross-change propagation or test step exists). - State that sync applies the whole delta -- a REMOVED requirement is deleted from the main spec and a RENAMED one retitled -- so the section no longer reads as additive-only. - Use the file's spaced em-dash convention. Docs-site build verified: sync-docs + fumadocs next build compile and render /docs/opsx end-to-end. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
e5c97b5 to
02c5938
Compare
alfred-openspec
left a comment
There was a problem hiding this comment.
The sync description now matches the whole-delta behavior and accurately explains preservation, removal, and rename semantics. The docs build and exact-head checks pass.
Supersedes #1061 (rebased onto
mainwith the merge conflict resolved). Original work by @HowardYan888 — thank you!Status
LGTM — merge-ready. Docs-only, verified safe and hardened.
What was missing / motivation
docs/opsx.mddescribed/opsx:syncinconsistently with the rest of the docs (commands.md,migration-guide.md, fixed in the merged #1059): it used "Sync … to main (default workflow, optional)" and had no Usage section for the command.What it does
Sync delta specs to main (default workflow, optional)→Merge delta specs into main specs (optional)(the canonical wording used incommands.mdandmigration-guide.md).Hardening (second commit)
Adversarially fact-checked every claim against
src/core/templates/workflows/sync-specs.tsandarchive-change.ts, then tightened the section:## REMOVEDrequirement is deleted from the main spec and a renamed one is retitled — the section no longer reads as additive-only.Proof it works
sync-docs.mjs→fumadocs-mdx→next build— exit 0,/docs/opsxrenders end-to-end with the edited content. Docs sync as plain.md(not.mdx), so there is no JSX/expression parsing to break.openspec/specs/, leaves the change active, archive prompts to sync, REMOVED/RENAMED applied).eslint src/✅,node build.js✅,vitest run→ 3859 passed. This branch's entire diff vsmainisdocs/opsx.md(git diff main...HEAD -- src/ test/is empty), so nothing in the CLI is touched.Notes
Closes #X: this is a docs-consistency cleanup following docs(migration-guide): fix inconsistent /opsx:sync description #1059; there is no open issue reporting the wording gap.archive-change.ts— no file overlap, no conflict).🤖 Generated with Claude Code
Summary by CodeRabbit
/opsx:syncmerges delta specifications into the main specifications.