Skip to content

docs: add the design-engine runs to the showcase - #547

Merged
ZuyiZhou merged 4 commits into
mainfrom
docs/readme_design_showcases
Sep 20, 2026
Merged

ZuyiZhou merged 4 commits into
mainfrom
docs/readme_design_showcases

Conversation

@ZuyiZhou

Copy link
Copy Markdown
Contributor

Summary

Adds a second row to the Showcase's non-deck table, bringing the design
engine's two output modes into the section: a poster campaign and an
interactive page.

Light-pollution poster campaign. The first case whose graph takes an
edge from the code side. Three Raven-Research nodes and a plate-generation
node run in parallel; a Raven-Code node computes the sky-brightness panel
from the research findings; a Raven-Design node composes the key visual and
the street, data-panel, social and banner cuts off one master plate, with
every headline and statistic set as live type rather than baked into the
generated pixels. The artifact image is the key visual over the four
derived formats.

Interactive GPS explainer. Two Raven-Code nodes write a trilateration
solver and an independent oracle in parallel, a Raven-Oncall node
cross-checks them, and a Raven-Design node builds the page on a generated
orbital plate. The artifact image is the live page above the fix at two,
three and four satellites, which is what shows the geometry is computed
rather than drawn.

Both images are hosted as GitHub user-attachments and referenced by URL.
Nothing is committed to the repository, per the repository-assets rule.

Type

  • Fix
  • Feature
  • Docs
  • CI / tooling
  • Refactor
  • Other

Verification

  • make check-large-files -> exit 0

  • make check-source-language -> exit 0

  • All four attachment URLs fetched anonymously with curl: HTTP 200, and
    each one's md5 compared against its local source file to confirm the
    right image sits behind the right URL.

  • Relevant tests pass locally

  • Relevant lint / type checks pass locally

  • User-facing docs or screenshots are updated when needed

Risk

README-only change. The two new cells add four remote images to the page;
if an attachment URL ever stops resolving the cell degrades to alt text.
Rollback is reverting the commit.

  • Security impact considered
  • Backward compatibility considered
  • Rollback path is clear for risky changes

Related Issues

Follows #517 and #520.

@gloryfromca gloryfromca left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Blocking: correct the two task-graph alt texts to match the depicted dependencies.

Both new graph descriptions route the independent plate-generation node through the intermediate Raven-Code or Raven-Oncall node, but the images show that node feeding the final Raven-Design node directly. The two inline findings identify the exact corrections needed.

Coverage: I read the full github/main...HEAD diff, the surrounding README and its history, and the applicable AGENTS.md, CLAUDE.md, CONTEXT-MAP.md, and domain vocabulary. I checked all four attachments anonymously and visually, confirmed GitHub's rendered table structure, reviewed the commit and PR record, and considered backward compatibility, test weakening, callers, and architecture boundaries. This is an additive README-only change with no callers, no weakened tests, and no runtime or TUI architecture impact.

Verification: scripts/check_large_files.py github/main..HEAD and scripts/check_source_language.py github/main..HEAD both passed locally under the pinned Python 3.12 environment. At posting time 16 GitHub checks had passed with no failures; one unit-test shard was still in progress. No application tests were run locally because the patch changes only README content.

Comment thread README.md Outdated
Comment thread README.md Outdated
@ZuyiZhou
ZuyiZhou force-pushed the docs/readme_design_showcases branch from 53ed8b3 to caa2049 Compare September 20, 2026 09:19

@gloryfromca gloryfromca left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Blocking: correct the two task-graph alt texts to match the depicted dependencies.

I reviewed the new revision. The alignment delta renders correctly and introduces no new finding, but both previously reported alt-text errors are unchanged in the current head. Those two open threads therefore still stand and are not resolved.

Coverage: I refreshed github/main, read the full README-only diff and the delta from the prior reviewed tree, checked the surrounding showcase and history, and rechecked the applicable AGENTS.md, CLAUDE.md, CONTEXT-MAP.md, domain-term, asset, backward-compatibility, test-weakening, caller, and architecture constraints. This remains additive documentation with no callers, weakened tests, or runtime/TUI architecture impact. GitHub's Markdown renderer preserves the intended three-row layout.

Verification: scripts/check_large_files.py github/main..HEAD and scripts/check_source_language.py github/main..HEAD both passed locally under Python 3.12. At posting time 13 GitHub checks had passed with no failures and four unit-test shards were still in progress; no application tests were run locally for this README-only patch.

@gloryfromca gloryfromca left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No blockers; this can merge as far as I am concerned.

Both prior alt-text findings are fixed in this revision, their closing replies are posted, and both threads are resolved. I found no new issue.

Coverage: I read the full github/main...HEAD README diff and the delta from the prior reviewed revision, checked the rendered GitHub HTML against the workflow images, and rechecked the applicable AGENTS.md, CLAUDE.md, CONTEXT-MAP.md, domain vocabulary, asset policy, history, backward compatibility, test weakening, callers, and architecture constraints. This is documentation-only, with no callers, weakened tests, or runtime/TUI architecture impact.

Verification: scripts/check_large_files.py github/main..HEAD and scripts/check_source_language.py github/main..HEAD both passed locally under Python 3.12. At posting time 15 GitHub checks had passed with no failures and two unit-test shards were still in progress; no application tests were run locally for this README-only patch.

ZuyiZhou and others added 4 commits September 20, 2026 17:35
Two more cases, both ending in something other than a deck: a
light-pollution poster campaign and an interactive GPS explainer.

The campaign run is the first case whose graph takes an edge from the
code side: three research nodes and a plate-generation node run in
parallel, a Raven-Code node computes the sky-brightness panel, and a
Raven-Design node composes the key visual plus the street, social and
banner cuts off one master. The explainer run pairs two Raven-Code
nodes, a solver and an independent oracle, into a Raven-Oncall
cross-check before the page is built.

Images are user-attachments, not repository files, per the assets rule.

Co-authored-by: Claude (claude-opus-5) <noreply@anthropic.com>
The pair sat unevenly: a two-line heading on the left pushed that
column's images down, and the two task graphs differ in height because
one has four stacked nodes and the other three, so the artifacts below
them started at different heights too.

Each case now spans three table rows - headings, graphs, artifacts - so
cells in a row share a top edge and a long heading no longer cascades
into the images. The graphs are centred and their widths set so both
render to one height, as are the two artifact sheets. Both headings are
short enough to hold one line.

Co-authored-by: Claude (claude-opus-5) <noreply@anthropic.com>
Both descriptions routed the Raven-Design plate node through the
intermediate node. The plate node feeds the final Raven-Design node
directly; its edge passes behind the intermediate card, which is why it
looks like it terminates on that card's lower border. Two connectors
emerge from behind that card and converge on one arrowhead.

Screen-reader users were getting a different graph from sighted readers.

Co-authored-by: Claude (claude-opus-5) <noreply@anthropic.com>
The plate node's connector ran behind the intermediate card, so it looked
like it terminated on that card's lower border rather than continuing to
the final Raven-Design node. Both graphs are redrawn with that edge routed
clear of the card, arriving at the final node under its own arrowhead.

The dependencies are unchanged; only the drawn path is.

Co-authored-by: Claude (claude-opus-5) <noreply@anthropic.com>
@ZuyiZhou
ZuyiZhou force-pushed the docs/readme_design_showcases branch from dfd8456 to 91a28cb Compare September 20, 2026 09:35

@gloryfromca gloryfromca left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No blockers; this can merge as far as I am concerned.

The substantive delta from the last reviewed revision is limited to two replacement workflow attachments. Both URLs return valid PNGs, GitHub renders them with the existing corrected alt text, and visual inspection confirms that each plate edge now reaches the final Raven-Design node on its own clear path. I found no new issue. The two earlier threads remain resolved.

Coverage: I read the full github/main...HEAD diff and separated the rebase-only README changes from the PR delta, checked the surrounding showcase and history, and rechecked the applicable AGENTS.md, CLAUDE.md, CONTEXT-MAP.md, domain vocabulary, asset policy, backward compatibility, test weakening, callers, and architecture constraints. This remains documentation-only, with no callers, weakened tests, or runtime/TUI architecture impact.

Verification: both replacement attachments returned HTTP 200 as PNGs; GitHub's Markdown renderer preserved them and their alt text. scripts/check_large_files.py github/main..HEAD and scripts/check_source_language.py github/main..HEAD passed locally under Python 3.12. At posting time 13 GitHub checks had passed with no failures and four unit-test shards were still in progress; no application tests were run locally for this README-only patch.

@ZuyiZhou
ZuyiZhou merged commit 8d74fb9 into main Sep 20, 2026
20 checks passed
@ZuyiZhou
ZuyiZhou deleted the docs/readme_design_showcases branch September 20, 2026 09:40
ZuyiZhou added a commit that referenced this pull request Sep 20, 2026
)

## Summary

Rebuilds the Showcase layout in both READMEs, and replaces one image.

**Why the old layout did not hold.** The section had grown to nine cases
across three tables of mixed shape. A heading that wrapped to two lines
pushed its column's images down. Paired task graphs of unequal height
left
the artifacts below them starting at different heights. And GitHub's
stylesheet stripes every second row while a case spanned three, so the
pattern drifted until some headings sat on white and others on the grey.

**What it is now.** Each case spans three rows - heading, task graph,
artifact - so cells in a row share a top edge and a long heading cannot
cascade into the images. Each pair gets its own table, which restarts
the
stripe and puts the usual gap between pairs. The game run keeps the
opening
slot and now takes the full width instead of leaving half a row empty.
Image widths are set per pair so both sides render to one height, and
the
narrower image is centred. The divider sentence that separated the old
tables is gone, since the headings already say it.

**A new comparison board.** The Frameworks artifact is replaced with a
redrawn plate: each framework carries its vendor mark, and the
orchestration style became a three-way tag - explicit graph or canvas,
declared task flow, dynamic at runtime - where the old plate split the
six
in two. Its alt text said "versus" and named two categories; it names
three
now. The render is 2000x1547 against the old 2000x1332, so its width is
set
to 86 percent to stay level with the sweep chart beside it.

## Type

- [ ] Fix
- [ ] Feature
- [x] Docs
- [ ] CI / tooling
- [ ] Refactor
- [ ] Other

## Verification

- `make check-large-files` -> exit 0
- `make check-source-language` -> exit 0
- The replacement board was fetched anonymously from its attachment URL:
HTTP 200, 2000x1547, and its md5 matched the local source file byte for
  byte.
- Rendered the section through GitHub's own markdown endpoint under the
published markdown stylesheet and read back the computed row
backgrounds.
  All five heading rows now report one background; before the split they
  reported two.
- Measured every image box in that render. All four pairs match on top
edge,
  and within 2px on height:

  | pair | left | right |
  | --- | --- | --- |
  | Song / Greece | 379x129 and 379x718 | 379x129 and 379x718 |
  | Pop / Abstract | 379x127 and 379x713 | 371x127 and 379x713 |
  | Frameworks / Sweep | 379x126 and 326x252 | 379x126 and 379x252 |
  | Poster / Explainer | 314x131 and 379x348 | 379x131 and 367x347 |

- Confirmed against the repository-rendered README that the game run's
bare
  attachment URL is served as a video player, and kept it on its own
  paragraph inside the cell so it still is.

- [ ] Relevant tests pass locally
- [x] Relevant lint / type checks pass locally
- [x] User-facing docs or screenshots are updated when needed

## Risk

Documentation only, in both READMEs. One of the seventeen attachments is
replaced, with its alt text rewritten to match the new plate's three-way
legend; the rest are untouched, and no file is committed to the
repository.
Rollback is reverting the commit.

- [ ] Security impact considered
- [x] Backward compatibility considered
- [x] Rollback path is clear for risky changes

## Related Issues

Follows #547 and #557.

Co-authored-by: Claude (claude-opus-5) <noreply@anthropic.com>
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.

3 participants