Skip to content

docs: CI Mermaid-to-PNG rendering proposal#14

Closed
diberry wants to merge 10 commits intodevfrom
squad/pao-ci-mermaid-proposal
Closed

docs: CI Mermaid-to-PNG rendering proposal#14
diberry wants to merge 10 commits intodevfrom
squad/pao-ci-mermaid-proposal

Conversation

@diberry
Copy link
Copy Markdown
Owner

@diberry diberry commented Mar 24, 2026

PAO: CI Mermaid Rendering Proposal

What's here

  • docs/research/ci-mermaid-rendering-proposal.md — recommends hybrid approach:
    • npm prebuild hook (docs/scripts/render-mermaid.js) for local dev
    • CI safety net in GitHub Actions to catch stale PNGs
    • Source .mmd files committed, generated PNGs git-ignored

Note

This branch also contains an unrelated state facade commit (7c85ac0) that was
committed here during a branch-switching incident. That code has been properly
consolidated onto diberry/sa-phase1-interface. Ignore the state files in diff.

Status

Proposal ready for review. Implementation depends on decision to adopt.

Copilot AI added 10 commits March 22, 2026 05:42
- Orchestration log: 2026-03-22T12-36Z-pao.md — PAO completed full docs catalog audit
- Session log: 2026-03-22T12-36Z-docs-catalog-audit.md — session summary
- Merged .squad/decisions/inbox/pao-docs-audit.md into decisions.md
- Updated PAO history.md with docs audit learnings (15 orphans, 0 dead links, 5 top actions)
- Deleted inbox file
- Docs audit found critical nav gaps, stale content, duplication; formalized 5 action items

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Orchestration: Booster completed whatsnew.md version sync automation (2026-03-22T12:46Z)
- Merged decision: whatsnew auto-sync via prebuild script + Vitest test gate
- Updated PAO history: Docs audit finding #1 (stale version) resolved
- Removed merged inbox decision: booster-whatsnew-sync.md

whatsnew.md heading now syncs on every build (local + CI), keeping release docs current with package.json version.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Orchestration log: 2026-03-22T12-55Z-pao.md (PAO DevRel spawn)
- Session log: 2026-03-22T12-55Z-docs-fixes.md
- Inbox: clean (no files to merge)

All 4 fires resolved. Build tests passing (23/23).
# Conflicts:
#	docs/src/content/docs/guide.md
#	docs/src/content/docs/tips-and-tricks.md
#	docs/src/content/docs/tour-first-session.md
…e orchestration + session logs

Orchestration logs created:
- 2026-03-24T11-55-00Z-control.md — State domain types, 218 tests passing
- 2026-03-24T11-55-00Z-eecom.md — IO layer + SquadState facade, 28+28 tests
- 2026-03-24T11-55-00Z-pao-research.md — JSDoc research complete
- 2026-03-24T11-55-00Z-pao-diagrams.md — 7 Mermaid architecture diagrams

Session log created:
- 2026-03-24T11-55-00Z-phase2-facade.md — Phase 2 foundation complete

Decision inbox merged:
- Appended 15 inbox files to decisions.md (APPEND ONLY per charter)
- Deleted all inbox files (clean)
- Decisions now canonical source of record

Phase 2 state facade work is production-ready. All tests passing. 0 blockers for Phase 3.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Proposed Option B (npm prebuild) + Option A (CI safety net) hybrid approach for pre-rendering Mermaid diagrams to PNG before docs deployment.

- Research document: docs/research/ci-mermaid-rendering-proposal.md
- Tool: @mermaid-js/mermaid-cli (mmdc)
- Source: .mmd files in docs/src/content/docs/*/diagrams/
- Output: PNGs in */images/ (git-ignored, generated at build)
- Execution: npm prebuild hook (works locally + CI)

Benefits:
- Excellent local DX (live preview, iterate on diagrams)
- Reliable CI (always fresh PNGs)
- Simple implementation (one script, npm lifecycle hook)
- No GitHub Actions pipeline changes needed

Decision summary: .squad/decisions/inbox/pao-ci-mermaid.md

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Added learning entry for CI Mermaid→PNG rendering proposal research.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Closes #6

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@diberry
Copy link
Copy Markdown
Owner Author

diberry commented Mar 27, 2026

Superseded by PR #11 (TypeDoc API reference).

@diberry diberry closed this Mar 27, 2026
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.

2 participants