Skip to content

Add comment marker preview #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sedge-bot wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add comment marker preview #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9984ba1
docs: add comment marker preview
May 14, 2026
fa401e3
docs: complete comment marker preview coverage
May 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,12 @@ Use punctuation markers in comments to flag human judgment:
| `??` | TODO, HACK | I'm uncertain | Purple (base0E) |
| `>>` | NOTE, NB | See reference | Cyan (base0C) |

The VS Code/Cursor extension highlights the whole comment line as a rounded badge. Legacy keywords use the same colors as their punctuation marker, so `FIXME`/`BUG`/`XXX` look like `!!`, `TODO`/`HACK` look like `??`, and `NOTE`/`NB` look like `>>`.

<p align="center">
<img src="site/assets/comment-marker-preview.svg" alt="Human++ comment marker preview showing FIXME, TODO, HACK, NOTE, NB, and explicit punctuation badges" width="650">
</p>

```js
// Regular comment stays calm (base03)

Expand Down
63 changes: 63 additions & 0 deletions site/assets/comment-marker-preview.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions templates/README.md.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,12 @@ Use punctuation markers in comments to flag human judgment:
| `??` | TODO, HACK | I'm uncertain | Purple (base0E) |
| `>>` | NOTE, NB | See reference | Cyan (base0C) |

The VS Code/Cursor extension highlights the whole comment line as a rounded badge. Legacy keywords use the same colors as their punctuation marker, so `FIXME`/`BUG`/`XXX` look like `!!`, `TODO`/`HACK` look like `??`, and `NOTE`/`NB` look like `>>`.

<p align="center">
<img src="site/assets/comment-marker-preview.svg" alt="Human++ comment marker preview showing FIXME, TODO, HACK, NOTE, NB, and explicit punctuation badges" width="650">
</p>

```js
// Regular comment stays calm (base03)

Expand Down
68 changes: 68 additions & 0 deletions tools/build.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1644,6 +1644,74 @@ def generate_svgs(colors, meta):
(assets_dir / "preview-light.svg").write_text(preview_light)
print(" ✓ site/assets/preview-dark.svg, preview-light.svg")

# Comment marker alias preview for issue triage / README clarity.
marker_preview = f'''<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 760 366" role="img" aria-labelledby="title desc">
<title id="title">Human++ comment marker preview</title>
<desc id="desc">Preview of Human++ comment marker badges for explicit punctuation and legacy keyword aliases.</desc>
<rect width="760" height="366" rx="12" fill="{c['base00']}"/>

<rect width="760" height="36" rx="12" fill="{c['base01']}"/>
<rect y="26" width="760" height="10" fill="{c['base01']}"/>
<circle cx="20" cy="18" r="6" fill="{c['base08']}"/>
<circle cx="40" cy="18" r="6" fill="{c['base0A']}"/>
<circle cx="60" cy="18" r="6" fill="{c['base0B']}"/>
<text x="380" y="23" text-anchor="middle" font-family="SF Mono, Consolas, monospace" font-size="12" fill="{c['base04']}">marker-aliases.ts</text>

<text x="28" y="67" font-family="SF Mono, Consolas, monospace" font-size="13" fill="{c['base03']}" text-anchor="end">1</text>
<text x="28" y="95" font-family="SF Mono, Consolas, monospace" font-size="13" fill="{c['base03']}" text-anchor="end">2</text>
<text x="28" y="123" font-family="SF Mono, Consolas, monospace" font-size="13" fill="{c['base03']}" text-anchor="end">3</text>
<text x="28" y="151" font-family="SF Mono, Consolas, monospace" font-size="13" fill="{c['base03']}" text-anchor="end">4</text>
<text x="28" y="179" font-family="SF Mono, Consolas, monospace" font-size="13" fill="{c['base03']}" text-anchor="end">5</text>
<text x="28" y="207" font-family="SF Mono, Consolas, monospace" font-size="13" fill="{c['base03']}" text-anchor="end">6</text>
<text x="28" y="235" font-family="SF Mono, Consolas, monospace" font-size="13" fill="{c['base03']}" text-anchor="end">7</text>
<text x="28" y="263" font-family="SF Mono, Consolas, monospace" font-size="13" fill="{c['base03']}" text-anchor="end">8</text>
<text x="28" y="291" font-family="SF Mono, Consolas, monospace" font-size="13" fill="{c['base03']}" text-anchor="end">9</text>
<text x="28" y="319" font-family="SF Mono, Consolas, monospace" font-size="13" fill="{c['base03']}" text-anchor="end">10</text>

<text x="44" y="67" font-family="SF Mono, Consolas, monospace" font-size="13" fill="{c['base03']}">// Regular comment stays calm and low-contrast</text>

<rect x="40" y="78" width="590" height="22" rx="4" fill="{c['base0F']}"/>
<text x="48" y="95" font-family="SF Mono, Consolas, monospace" font-size="13" fill="{c['base00']}" font-weight="700">// FIXME: payment retry can double-submit</text>
<text x="650" y="95" font-family="SF Mono, Consolas, monospace" font-size="12" fill="{c['base0F']}" font-weight="700">!!</text>

<rect x="40" y="106" width="590" height="22" rx="4" fill="{c['base0F']}"/>
<text x="48" y="123" font-family="SF Mono, Consolas, monospace" font-size="13" fill="{c['base00']}" font-weight="700">// BUG: cache invalidation skips deleted users</text>
<text x="650" y="123" font-family="SF Mono, Consolas, monospace" font-size="12" fill="{c['base0F']}" font-weight="700">!!</text>

<rect x="40" y="134" width="590" height="22" rx="4" fill="{c['base0F']}"/>
<text x="48" y="151" font-family="SF Mono, Consolas, monospace" font-size="13" fill="{c['base00']}" font-weight="700">// XXX: verify migration before rollout</text>
<text x="650" y="151" font-family="SF Mono, Consolas, monospace" font-size="12" fill="{c['base0F']}" font-weight="700">!!</text>

<rect x="40" y="162" width="590" height="22" rx="4" fill="{c['base0E']}"/>
<text x="48" y="179" font-family="SF Mono, Consolas, monospace" font-size="13" fill="{c['base07']}" font-weight="700">// TODO: choose a better empty-state copy</text>
<text x="650" y="179" font-family="SF Mono, Consolas, monospace" font-size="12" fill="{c['base0E']}" font-weight="700">??</text>

<rect x="40" y="190" width="590" height="22" rx="4" fill="{c['base0E']}"/>
<text x="48" y="207" font-family="SF Mono, Consolas, monospace" font-size="13" fill="{c['base07']}" font-weight="700">// HACK: keep legacy slug routing alive for now</text>
<text x="650" y="207" font-family="SF Mono, Consolas, monospace" font-size="12" fill="{c['base0E']}" font-weight="700">??</text>

<rect x="40" y="218" width="590" height="22" rx="4" fill="{c['base0C']}"/>
<text x="48" y="235" font-family="SF Mono, Consolas, monospace" font-size="13" fill="{c['base00']}" font-weight="700">// NOTE: this mirrors the server-side validator</text>
<text x="650" y="235" font-family="SF Mono, Consolas, monospace" font-size="12" fill="{c['base0C']}" font-weight="700">&gt;&gt;</text>

<rect x="40" y="246" width="590" height="22" rx="4" fill="{c['base0C']}"/>
<text x="48" y="263" font-family="SF Mono, Consolas, monospace" font-size="13" fill="{c['base00']}" font-weight="700">// NB: redirects intentionally preserve the query string</text>
<text x="650" y="263" font-family="SF Mono, Consolas, monospace" font-size="12" fill="{c['base0C']}" font-weight="700">&gt;&gt;</text>

<rect x="40" y="274" width="590" height="22" rx="4" fill="{c['base0F']}"/>
<text x="48" y="291" font-family="SF Mono, Consolas, monospace" font-size="13" fill="{c['base00']}" font-weight="700">// !! Explicit punctuation always works too</text>
<text x="650" y="291" font-family="SF Mono, Consolas, monospace" font-size="12" fill="{c['base0F']}" font-weight="700">!!</text>

<rect x="40" y="302" width="590" height="22" rx="4" fill="{c['base0C']}"/>
<text x="48" y="319" font-family="SF Mono, Consolas, monospace" font-size="13" fill="{c['base00']}" font-weight="700">// &gt;&gt; Explicit context note stays visible</text>
<text x="650" y="319" font-family="SF Mono, Consolas, monospace" font-size="12" fill="{c['base0C']}" font-weight="700">&gt;&gt;</text>

<text x="44" y="346" font-family="SF Mono, Consolas, monospace" font-size="12" fill="{c['base04']}">Aliases are case-insensitive; strongest marker wins when multiple keywords appear.</text>
</svg>
'''
(assets_dir / "comment-marker-preview.svg").write_text(marker_preview)
print(" ✓ site/assets/comment-marker-preview.svg")



def generate_readme(colors, meta):
Expand Down