From a6e2a6827ded3e4a69b2ca1214aa7f5235802328 Mon Sep 17 00:00:00 2001 From: safishamsi Date: Thu, 27 Aug 2026 18:32:51 +0100 Subject: [PATCH] docs(readme): tighten the git-workflow rebuild claims (#3112) Two accuracy corrections to the Recommended workflow table: the post-checkout hook rebuilds only on branch switches (not a file-only git checkout -- ), and the commit/switch rebuilds run detached in the background so the graph can briefly lag the commit. --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b4ff649a..0b3fba6b 100644 --- a/README.md +++ b/README.md @@ -445,10 +445,12 @@ Set this up once per clone. From then on, three of your normal git commands keep |---|---| | `graphify hook install` (once, right after cloning) | installs the hooks below, plus a merge driver so `graph.json` never shows conflict markers | | `git commit` | rebuilds automatically — AST only, no API cost | -| `git checkout` / `git switch` | rebuilds automatically | +| `git checkout` / `git switch` (branches) | rebuilds automatically (a file-only `git checkout -- ` does not) | | `git pull` / `git merge` | run `graphify update .` right after | | `git push` | nothing to do | +The commit and branch-switch rebuilds run in the background and return immediately, so on a large repo the graph can lag the commit by a few seconds — step 5 covers the rare case where you query before it catches up. + **Step by step:** 1. Clone the repo and run `graphify hook install` once. 2. Commit and switch branches as normal — the graph stays current on its own.