Skip to content

docs(workflows): fix sequence diagram rendering - #1654

Merged
clay-good merged 2 commits into
mainfrom
codex/fix-workflow-sequence-diagram
Aug 19, 2026
Merged

docs(workflows): fix sequence diagram rendering#1654
clay-good merged 2 commits into
mainfrom
codex/fix-workflow-sequence-diagram

Conversation

@clay-good

@clay-good clay-good commented Aug 14, 2026

Copy link
Copy Markdown
Collaborator

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 main GitHub 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

@clay-good
clay-good requested a review from a team as a code owner August 14, 2026 18:29
@clay-good
clay-good requested review from TabishB and removed request for a team August 14, 2026 18:29
@coderabbitai

coderabbitai Bot commented Aug 14, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 6e1b86b4-a376-44f4-b130-83e2632bce77

📥 Commits

Reviewing files that changed from the base of the PR and between 2826b88 and 4fab226.

📒 Files selected for processing (1)
  • docs/workflows.md

📝 Walkthrough

Walkthrough

The archive workflow documentation clarifies that the CLI alternative validates first, then applies delta specs and archives when confirmation prompts are skipped.

Changes

Archive workflow documentation

Layer / File(s) Summary
Clarify CLI archive execution order
docs/workflows.md
The archive workflow note now states the CLI sequence: validate, apply delta specs, and archive when confirmation prompts are skipped.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to 4fab2

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: tabishb

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Linked Issues check ✅ Passed The change fixes the Mermaid syntax issue described in #1639 and restores diagram rendering.
Out of Scope Changes check ✅ Passed The one-line documentation change is directly related to the linked issue and PR objective.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the documentation change to fix workflow sequence diagram rendering.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/fix-workflow-sequence-diagram

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.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Aug 14, 2026

Copy link
Copy Markdown

Deploying openspec-docs with  Cloudflare Pages  Cloudflare Pages

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

View logs

@clay-good
clay-good added this pull request to the merge queue Aug 19, 2026
Merged via the queue into main with commit 98c7932 Aug 19, 2026
18 checks passed
@clay-good
clay-good deleted the codex/fix-workflow-sequence-diagram branch August 19, 2026 20:25
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.

Sequence diagram not rendering on Github on workflows docs

2 participants