Skip to content

Commit dc8178b

Browse files
authored
Squetch notes with PRs (#1511)
* check node is correctly installed and it is the correct version * ✨ Add PR visual sketch generation script - Introduces a script to generate visual notes from pull request diffs. * ✨ Add sketchnotes section to zine post Added sketchnotes as a new visual format for PR summaries. Updated tags. * ✨ Add new PR link and image to zine-prs blog Included a new PR link and corresponding image in the blog.
1 parent 192d250 commit dc8178b

1 file changed

Lines changed: 24 additions & 1 deletion

File tree

docs/src/content/docs/blog/zine-prs.mdx

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Zine Meets Pull Requests
2+
title: Zine Meets Pull Requests (and more)
33
description: A reflection about the influence of new image generator and their
44
impacts on the software development assets like pull requests.
55
date: 2025-04-29
@@ -12,6 +12,7 @@ tags:
1212
- zines
1313
- gpt-image-1
1414
- software annotation
15+
- sketchnotes
1516
excerpt: Recent progress in AI image generation offers new possibilities for
1617
documenting and reviewing code changes. By using a two-step process—first
1718
converting a pull request diff into a visual prompt through a language model
@@ -26,13 +27,20 @@ excerpt: Recent progress in AI image generation offers new possibilities for
2627

2728
import { Code } from "@astrojs/starlight/components"
2829
import code from "../../../../../packages/sample/genaisrc/samples/prd-zine.genai.mts?raw"
30+
import sketchCode from "../../../../../packages/sample/genaisrc/samples/prd-sketch.genai.mts?raw"
2931
import BlogNarration from "../../../components/BlogNarration.astro"
3032

3133
<BlogNarration />
3234

3335
The availability of new image generators like OpenAI `gpt-image-1` opens
3436
the door to endless new ways to visualize and annotate software artifacts.
3537

38+
:::tip
39+
40+
It also works for **sketchnotes!**
41+
42+
:::
43+
3644
## Zines
3745

3846
["Zine"](https://en.wikipedia.org/wiki/Zine) is a popular graphic art form that combines text and images to tell a story.
@@ -62,6 +70,21 @@ The script below is a 2 step LLM transformation of the pull request into a zine:
6270

6371
![](https://raw.githubusercontent.com/microsoft/genaiscript/refs/heads/genai-assets/1b560d071efb015942678ffc705eac01e0d1dad8fd1e88ab521c0283a535a278.jpg)
6472

73+
## Sketchnotes (updated)
74+
75+
["Sketchnotes"](https://sketchyideas.co/sketchnotes/) is another style of visual note-taking that combines hand-drawn elements with text to convey information.
76+
It is a great way to summarize a pull request and make it more engaging.
77+
78+
<Code code={sketchCode} lang="ts" wrap title="prd-sketch.genai.mts" />
79+
80+
- https://github.com/microsoft/genaiscript/pull/1510
81+
82+
![](https://raw.githubusercontent.com/microsoft/genaiscript/refs/heads/genai-assets/034e747af0809c2ed0ed02f5e980cce1f48a6f80e0a3c63818694d3afa34647a.jpg)
83+
84+
- https://github.com/microsoft/genaiscript/pull/1511
85+
86+
![](https://raw.githubusercontent.com/microsoft/genaiscript/refs/heads/genai-assets/d9461598f48703dceb7e4dd381292b713c993dbbde2dec3f2b2b18858d774dfb.jpg)
87+
6588
## More to come
6689

6790
The zine is a fun way to visualize the pull request diff. It is not perfect but it is inviting

0 commit comments

Comments
 (0)