typos

Author: bwalsh

docs/README-comparison.md

@@ -9,7 +9,7 @@ A comparative overview of two distinct approaches to managing and storing large
 
 **Key Features:**
 
-- **Pointer-Based Storage:** Replaces large files (e.g., audio, video, datasets) in the Git repository with lightweight text pointers, while storing the actual file contents on a remote server. citeturn0search0
+- **Pointer-Based Storage:** Replaces large files (e.g., audio, video, datasets) in the Git repository with lightweight text pointers, while storing the actual file contents on a remote server.
 
 - **Seamless Git Integration:** Allows developers to use standard Git commands (`add`, `commit`, `push`, `pull`) without altering their workflow.
 

docs/README-release-test.md

@@ -1,27 +1,41 @@
-# 🧪 `git-gen3` Pilot Test Script
+# 🧪 `lfs-meta` Pilot Test Script
 
-> Please follow the steps below to test core functionality of the `git-gen3` tool. Report any issues to the project team via GitHub or the feedback form.
+> Please follow the steps below to test core functionality of the `lfs-meta` tool. Report any issues to the project team via GitHub or the feedback form.
 
 ---
 
 ## ✅ Prerequisites
 
 Before starting, ensure you have:
 
-- Access to a Git repo cloned from the `git-gen3` template
-- A working installation of the `git-gen3` CLI
+- Access to a Git repo cloned from the `lfs-meta` template
+- A working installation of the `lfs-meta` CLI
 - Access to an S3, GCS, or Azure bucket (read-only)
 - Python or Go runtime (depending on implementation)
 - A `fence` endpoint (or staging Gen3 system) if testing user sync
 
+---
+
+## 🧭 Part 0 – Track a Local File
+
+### 1.1 Track a local File
+
+```bash
+git add data/test.vcf
+```
+
+✅ Expected result:
+- `.lfs-meta/metadata.json` is updated 
+
+
 ---
 
 ## 🧭 Part 1 – Track a Remote File
 
 ### 1.1 Track a Remote File
 
 ```bash
-git-gen3 track-remote s3://my-bucket/path/to/test.vcf \
+lfs-meta track-remote s3://my-bucket/path/to/test.vcf \
   --path data/test.vcf \
   --patient Patient/1234 \
   --specimen Specimen/XYZ
@@ -50,7 +64,7 @@ git commit -m "Track remote object test.vcf"
 ### 2.1 Generate `DocumentReference.ndjson`
 
 ```bash
-git-gen3 init-meta \
+lfs-meta init-meta \
   --input .lfs-meta/metadata.json \
   --output META/DocumentReference.ndjson \
   --bucket s3://my-bucket
@@ -65,7 +79,7 @@ git-gen3 init-meta \
 ### 2.2 Validate the Output
 
 ```bash
-git-gen3 validate-meta --file META/DocumentReference.ndjson
+lfs-meta validate-meta --file META/DocumentReference.ndjson
 ```
 
 ✅ Expected result:
@@ -96,7 +110,7 @@ roles:
 ### 3.2 Dry-Run the Sync
 
 ```bash
-git-gen3 sync-users --dry-run --input .access.yaml
+lfs-meta sync-users --dry-run --input .access.yaml
 ```
 
 ✅ Expected result:
@@ -108,7 +122,7 @@ git-gen3 sync-users --dry-run --input .access.yaml
 ### 3.3 Apply the Sync (Optional)
 
 ```bash
-git-gen3 sync-users --input .access.yaml --confirm
+lfs-meta sync-users --input .access.yaml --confirm
 ```
 
 ✅ Expected result:

docs/README.md

@@ -6,17 +6,17 @@ Welcome to the `git-gen3` documentation! Below is an index of the available docu
 
 ## 📚 Documentation Files
 
-0.[README-comparison](README-comparison.md)
+1. [README-comparison](README-comparison.md)
    - A comparison of the `lfs-meta` tool with other tools and approaches.
    - Discusses the advantages and disadvantages of each approach.
    - Provides a summary of the key features and capabilities of `lfs-meta`.
-1. [Architecture and Sprint Plan](README-epic.md)
+2. [Architecture and Sprint Plan](README-epic.md)
    - Overview of project goals, sprint breakdowns, and deliverables.
-2. [Git LFS Metadata Tracking](README-gitlfs.md)
+3. [Git LFS Metadata Tracking](README-gitlfs.md)
     - Details on how to track large files using Git LFS
-3. [Git LFS Metadata](README-gitlfs-meta.md)
+4. [Git LFS Metadata](README-gitlfs-meta.md)
     - Information on how to manage metadata for large files in Git.
-4. [Git LFS Remote Buckets](README-gitlfs-remote-buckets.md)
+5. [Git LFS Remote Buckets](README-gitlfs-remote-buckets.md)
     - Details for tracking remote files without downloading them.
-5. [Release Testing](README-release-test.md)
+6. [Release Testing](README-release-test.md)
     - Guidelines for testing the release process and ensuring functionality.