Skip to content

Commit 1fd8550

Browse files
timeleft--claude
andcommitted
docs: address code review — tighten audit trail claim, clarify push path, name JJ in comments
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent e9649a1 commit 1fd8550

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
**Federated Agents Versioned Audit Trail** — Git-native, curated memory for AI agents via MCP.
1010

11-
Every thought, decision, and observation is stored as a markdown file with YAML frontmatter in a Git repo you control, with crash-proof persistence and an immutable audit trail. Agents interact through [MCP](https://modelcontextprotocol.io/) tools — they never see VCS commands.
11+
Every thought, decision, and observation is stored as a markdown file with YAML frontmatter in a Git repo you control, with crash-proof persistence and a versioned audit trail. Agents interact through [MCP](https://modelcontextprotocol.io/) tools — they never see VCS commands.
1212

1313
## Why
1414

@@ -23,7 +23,7 @@ Every thought, decision, and observation is stored as a markdown file with YAML
2323

2424
### Prerequisites
2525

26-
FAVA Trails uses [Jujutsu (JJ)](https://jj-vcs.github.io/jj/) as its storage engine, running in colocate mode alongside Git. Your repo remains a standard Git repo (push to GitHub, CI/CD sees normal commits). One-time install:
26+
FAVA Trails uses [Jujutsu (JJ)](https://jj-vcs.github.io/jj/) as its storage engine, running in colocate mode alongside Git. Your repo remains a standard Git repo (GitHub and CI/CD see normal commits; pushes go through the `sync` MCP tool or `jj git push`). One-time install:
2727

2828
```bash
2929
fava-trails install-jj
@@ -53,7 +53,7 @@ uv sync
5353
# Create an empty repo on GitHub (or any git remote), then clone it
5454
git clone https://github.com/YOUR-ORG/fava-trails-data.git
5555

56-
# Bootstrap it (creates config, .gitignore, initializes storage engine)
56+
# Bootstrap it (creates config, .gitignore, initializes JJ in colocate mode)
5757
fava-trails bootstrap fava-trails-data
5858
```
5959

@@ -176,7 +176,7 @@ FAVA Trails uses git remotes for cross-machine sync. The `fava-trails bootstrap`
176176
# 1. Install FAVA Trails
177177
pip install fava-trails
178178

179-
# 2. Install the storage engine (runs alongside Git in colocate mode)
179+
# 2. Install JJ (storage engine; runs alongside Git in colocate mode)
180180
fava-trails install-jj
181181

182182
# 3. Clone the SAME data repo (handles colocated mode + bookmark tracking)

0 commit comments

Comments
 (0)