Skip to content

Commit 3964fb8

Browse files
committed
docs: align git-warp upgrade guidance (#312)
1 parent 8eba886 commit 3964fb8

6 files changed

Lines changed: 21 additions & 13 deletions

File tree

AGENTS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,8 @@ Your space. Write about whatever you want:
108108

109109
## 5. TECH STACK REFERENCE
110110

111-
- **Runtime**: Node.js >= 20, ES modules
112-
- **Core dependency**: `@git-stunts/git-warp` (local path, CRDT graph on Git)
111+
- **Runtime**: Node.js >= 22, ES modules
112+
- **Core dependency**: `@git-stunts/git-warp` (published package, CRDT graph on Git)
113113
- **Plumbing**: `@git-stunts/plumbing` (must be installed as direct dependency)
114114
- **Tests**: vitest
115115
- **Style**: Plain JS with JSDoc, no TypeScript

CLAUDE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,8 @@ Your space. Write about whatever you want:
108108

109109
## 5. TECH STACK REFERENCE
110110

111-
- **Runtime**: Node.js >= 20, ES modules
112-
- **Core dependency**: `@git-stunts/git-warp` (local path, CRDT graph on Git)
111+
- **Runtime**: Node.js >= 22, ES modules
112+
- **Core dependency**: `@git-stunts/git-warp` (published package, CRDT graph on Git)
113113
- **Plumbing**: `@git-stunts/plumbing` (must be installed as direct dependency)
114114
- **Tests**: vitest
115115
- **Style**: Plain JS with JSDoc, no TypeScript

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,9 @@ GitHub milestones are not the primary planning surface for this repository.
5555

5656
## Prerequisites
5757

58-
- Node.js >= 20.0.0
58+
- Node.js >= 22.0.0
5959
- Git
60-
- A local clone of [`@git-stunts/git-warp`](https://github.com/nicktomlin/git-warp) (git-mind depends on it via local path)
60+
- npm access to install published dependencies, including [`@git-stunts/git-warp`](https://github.com/nicktomlin/git-warp)
6161

6262
## Setup
6363

GUIDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ cd git-mind
6464
npm install
6565
```
6666

67-
git-mind depends on `@git-stunts/git-warp`, which is currently installed from a local path. See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup details.
67+
git-mind depends on the published `@git-stunts/git-warp` package. See [CONTRIBUTING.md](CONTRIBUTING.md) for current development setup details.
6868

6969
### Verify the installation
7070

TECH-PLAN.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The key insight: **Git is already a graph database.** It has an immutable object
2020

2121
## 2. Storage Layer: git-warp
2222

23-
git-mind delegates persistence to **@git-stunts/git-warp** (v10.3.2), a CRDT graph database that uses Git's object store as its backend.
23+
git-mind delegates persistence to **@git-stunts/git-warp**. The specific version in use is defined in [package.json](package.json); this historical document originally described the `v10.3.2` era of the substrate.
2424

2525
### How data gets stored
2626

docs/design/git-warp-upgrade-audit.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# git-warp Upgrade Audit
22

3-
Status: draft for execution
3+
Status: active execution on `feat/git-warp-upgrade-audit`
44

55
Related:
66

@@ -29,7 +29,7 @@ It is a boundary audit plus upgrade cycle.
2929

3030
## Context
3131

32-
Current local dependency state:
32+
Cycle starting state:
3333

3434
- declared in `package.json` as `^11.5.0`
3535
- locked and installed at `11.5.0`
@@ -38,7 +38,11 @@ Live npm registry state checked on 2026-03-25:
3838

3939
- latest published `@git-stunts/git-warp` version: `14.16.2`
4040

41-
That means Git Mind is currently three major versions behind the latest published package.
41+
Chosen upgrade target for this cycle:
42+
43+
- `14.16.2`
44+
45+
That means this cycle upgrades Git Mind across three major versions of the substrate.
4246

4347
This does not automatically mean "upgrade immediately no matter what."
4448
It does mean Git Mind should not keep expanding Hill 1 behavior without auditing the real upgrade surface first.
@@ -106,9 +110,13 @@ The upgrade should pay special attention to:
106110

107111
## Known Mismatches Already Exposed
108112

109-
At least one contributor-facing document still says Git Mind depends on git-warp via a local path.
113+
This cycle exposed one concrete runtime compatibility change:
114+
115+
- `graph.getNodeProps()` now returns plain objects rather than `Map` instances
116+
117+
Git Mind must treat node property bags as a compatibility boundary rather than assuming a single container shape.
110118

111-
That no longer matches the actual package metadata and should be corrected as part of this cycle.
119+
This cycle also started with contributor-facing docs that still claimed git-warp was installed via local path. Those docs should be corrected as part of the upgrade.
112120

113121
## Acceptance Criteria
114122

0 commit comments

Comments
 (0)