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: |
d654121
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://1d0ace33.openspec-docs.pages.dev |
| Branch Preview URL: | https://codex-fix-workflow-sequence.openspec-docs.pages.dev |
Risk: none. One character in one documentation file. No source, no tests.
What was wrong
The workflow sequence diagram didn't render on GitHub. A semicolon in the final note was read by Mermaid as a statement separator, so it tried to parse the rest of the sentence as diagram syntax and gave up.
What changes
That semicolon becomes a period. Same meaning, valid syntax.
Proof
On
mainGitHub reports a parse error on line 37 and shows no diagram. On this branch the full diagram renders. An independent Mermaid renderer returns 400 for the old source and 200 for the new one.Closes #1639