Skip to content

docs: embed rendered flow-diagram preview in the README - #8

Merged
phj6688 merged 1 commit into
mainfrom
docs/readme-embed-diagram
Jul 11, 2026
Merged

phj6688 merged 1 commit into
mainfrom
docs/readme-embed-diagram

Conversation

@phj6688

@phj6688 phj6688 commented Jul 11, 2026

Copy link
Copy Markdown
Owner

The README's "Flow diagram" section only had a text link to docs/linear-issue-craft-flow.drawio, which GitHub does not render inline, so the diagram was invisible to anyone browsing the repo.

This adds a rendered PNG export (docs/linear-issue-craft-flow.png, from the pinned headless drawio image) and embeds it in the README. The .drawio stays the editable source; the PNG is the viewable preview. SVG was intentionally not used (drawio SVG text lives in foreignObject, which GitHub can render blank).

Docs-only; CI unaffected.

Summary by CodeRabbit

  • Documentation
    • Updated the README to display a rendered flow diagram preview.
    • Expanded the flow diagram section to explain its coverage and identify the editable source file.
    • Updated the changelog to reflect the embedded image presentation.

GitHub does not render .drawio inline, so the README only had a text link. Add a rendered PNG export of the diagram and embed it, keeping the .drawio as the editable source.
@phj6688
phj6688 enabled auto-merge (squash) July 11, 2026 10:52
@coderabbitai

coderabbitai Bot commented Jul 11, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 7d4e140c-676a-4bc3-91d2-afee065ed8d6

📥 Commits

Reviewing files that changed from the base of the PR and between e77dcc3 and 4a9bbb8.

⛔ Files ignored due to path filters (1)
  • docs/linear-issue-craft-flow.png is excluded by !**/*.png
📒 Files selected for processing (2)
  • CHANGELOG.md
  • README.md

Disabled knowledge base sources:

  • Linear integration is disabled

You can enable these sources in your CodeRabbit configuration.


📝 Walkthrough

Walkthrough

The README now embeds a rendered PNG flow diagram and explains its covered stages and editable draw.io source. The changelog entry reflects this presentation.

Changes

Flow Diagram Documentation

Layer / File(s) Summary
Embed and document flow diagram
README.md, CHANGELOG.md
The README embeds the rendered flow image, describes the classification, drafting, gates, and file path, and identifies the draw.io source for edits; the changelog records the change.

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

Poem

I’m a bunny with a diagram bright,
PNG petals blooming in README light.
The draw.io source stays close at hand,
Mapping each gate across the land.
Hop, hop—clear paths now stand!

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-embed-diagram

Comment @coderabbitai help to get the list of available commands.

@phj6688
phj6688 merged commit 7aa657a into main Jul 11, 2026
6 of 7 checks passed
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.

1 participant