docs: embed rendered flow-diagram preview in the README - #8
Merged
Merged
Conversation
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
enabled auto-merge (squash)
July 11, 2026 10:52
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (2)
Disabled knowledge base sources:
📝 WalkthroughWalkthroughThe README now embeds a rendered PNG flow diagram and explains its covered stages and editable draw.io source. The changelog entry reflects this presentation. ChangesFlow Diagram Documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes Poem
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.drawiostays the editable source; the PNG is the viewable preview. SVG was intentionally not used (drawio SVG text lives inforeignObject, which GitHub can render blank).Docs-only; CI unaffected.
Summary by CodeRabbit