Skip to content

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

Open
clay-good wants to merge 1 commit into
mainfrom
codex/fix-workflow-sequence-diagram
Open

docs(workflows): fix sequence diagram rendering#1654
clay-good wants to merge 1 commit into
mainfrom
codex/fix-workflow-sequence-diagram

Conversation

@clay-good

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

Copy link
Copy Markdown
Collaborator

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

  • On main, GitHub reports a Mermaid parse error on line 37 and renders no sequence diagram.
  • On this branch, GitHub renders the complete sequence diagram, including the corrected final note.
  • The original source returns HTTP 400 from an independent Mermaid renderer; the corrected source returns HTTP 200.
  • Root lint and build pass.
  • The full documentation website production build passes and generates 87 static pages.
  • Three independent adversarial reviews found no compatibility, architecture, overlap, or parity concerns.

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

  • Documentation
    • Clarified the archive workflow diagram to explain that the CLI alternative validates first, then applies delta specifications and archives when confirmation prompts are skipped.

@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 that fixes 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

Copy link
Copy Markdown

Deploying openspec-docs with  Cloudflare Pages  Cloudflare Pages

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

View logs

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

1 participant