Repository navigation
Rewrite the README for first-time users, reference moved to docs/ - #23
Merged
Merged
Conversation
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 is now a 111-line page for a PHP developer seeing phpgraph for the first time: the problem, one measured result, a one-command install,
mcp-config claude, four example questions and the main limitations. The reference material moves todocs/, and no code changes.README.mdandREADME.fr.mdrewritten. The French one is a translation of the English one.docs/ARCHIVE.md: the previous README, unchanged.docs/BENCHMARKS.md(renamed fromBENCHMARK.md): results grouped by phpgraph version and agent, with single-run and private results marked. It also holds the comparisons with other code graphs and the corpus table.docs/BENCHMARK.mdis now a stub, becausetools/agent-bench/and the changelog still link to it.docs/:INSTALL,MCP-TOOLS,CLI,GRAPH(relations, confidence levels),RULES(phpgraph check,phpgraph.yaml),FRAMEWORKS(matrix, microservices, XML action routing),LIMITATIONS,FAQ. Their text is moved word for word from the old README.Headline result: Akeneo, the
byCode()impact task, Claude Code 2.1.323 with Sonnet, 3 runs per arm. Both arms answered 3/3; the median tokens were 86,174 with phpgraph and 174,735 without, and the time was not better. The README says this is the best impact task, and that the other five ranged from +1 % to +56 % tokens.Corrections made while moving the text:
corpus/RESULTS.md.composer require --devfails in a project pinned below 8.5.Still open, not changed here:
hbenabdallah/phpgraph.