docs(workflows): fix sequence diagram rendering - #1654
Conversation
|
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)
📝 WalkthroughWalkthroughThe archive workflow documentation clarifies that the CLI alternative validates first, then applies delta specs and archives when confirmation prompts are skipped. ChangesArchive workflow documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes Merge Risk: ⚪ Minimal · up to This documentation-only change fixes the workflow sequence diagram rendering without affecting application behavior, and no actionable merge-blocking risk remains after normal checks and review. 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: |
4fab226
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://d7e55584.openspec-docs.pages.dev |
| Branch Preview URL: | https://codex-fix-workflow-sequence.openspec-docs.pages.dev |
Status: LGTM.
What was wrong
The workflow sequence diagram did not render on GitHub. Mermaid treated a semicolon in the final note as a statement separator, then tried to parse the remaining prose as diagram syntax.
How it was fixed
Replace that semicolon with a period. This preserves the note's meaning and changes documentation only.
Replication / proof
main, GitHub reports a Mermaid parse error on line 37 and renders no sequence diagram.Notes / nits
No changeset is needed for this documentation-only correction. Clean hosted CI passed the full test suite on Linux, macOS, and Windows. This PR changes no source or test files.
Closes #1639
Summary by CodeRabbit