Skip to content

README: where phpgraph helps and where it doesn't, demo GIF, video, screenshots and social card - #24

Merged
hbenabdallah merged 1 commit into
mainfrom
docs/readme-enhance
Nov 14, 2026
Merged

hbenabdallah merged 1 commit into
mainfrom
docs/readme-enhance

Conversation

@hbenabdallah

@hbenabdallah hbenabdallah commented Nov 14, 2026 •

Copy link
Copy Markdown
Collaborator

This PR repositions the README and adds demo assets. No code changes.

README (English and French, 118 lines)

  • The intro says when phpgraph pays off: on the largest project measured, for a question about the impact of a change. On smaller projects the same kind of question cost more tokens.
  • "Where it helps and where it doesn't": the Akeneo table (median 86,174 vs 174,735 tokens, both arms 3/3) stays. Next to it: on the 5 other impact tasks phpgraph used 1 % to 56 % more tokens, and time was not better on the Akeneo task.
  • A Demo section with the terminal GIF and a link to the video.

Assets (docs/assets/, 2.9 MB)

  • demo.gif: mcp-config claude, build, impact on php-ddd-example, real output, 21.6 s.
  • demo-video.mp4 (68 s, 1080p) and demo-side-by-side.gif: the Akeneo impact question to Claude Code (Sonnet), without and with phpgraph. Each pane is one real run, replayed at its recorded speed. Both runs named the 7 expected classes; without phpgraph 59,553 tokens and 6 tool calls, with it 53,478 tokens and 4 tool calls. A results card puts this single run next to the benchmark medians and caveats.
  • shot-1..3.png: the agent answer with phpgraph, the benchmark report rows for that task, and a route-to-service path.
  • social-card.png (1280x640), to upload under Settings > Social preview.

How to rebuild (docs/demo/): VHS tapes, the recording and redaction scripts, the two recordings with home paths masked, and make-video.sh. VIDEO_SCRIPT.md, SCREENSHOTS.md and SOCIAL_CARD.md describe each asset and its sources.

Not found in the benchmark: a task where the run without phpgraph missed a class that the run with it found. Its failures were namespaces guessed from the path. The video does not claim one.

@hbenabdallah hbenabdallah changed the title Docs/readme enhance README: where phpgraph helps and where it doesn't, demo GIF, video, screenshots and social card Nov 14, 2026
@hbenabdallah
hbenabdallah merged commit 52d97cf into main Nov 14, 2026
2 checks passed
@hbenabdallah
hbenabdallah deleted the docs/readme-enhance branch November 14, 2026 20:15
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