docs: document public loop-worktree lock import in QUICKSTART (#426) - #433
Open
AIMindCrafter wants to merge 1 commit into
Open
docs: document public loop-worktree lock import in QUICKSTART (#426)#433AIMindCrafter wants to merge 1 commit into
AIMindCrafter wants to merge 1 commit into
Conversation
Contributor
|
Thanks @AIMindCrafter for contributing a docs improvement — visible, reviewable PRs like this grow the reference for everyone. What happens next
More ways to help — loop-engineering maintainers |
cobusgreyling
requested changes
Jul 29, 2026
cobusgreyling
left a comment
Owner
There was a problem hiding this comment.
Review
Useful docs for #426 (CLI lock/unlock + public lock subpath), but the JS import example is wrong and would mislead copy-paste users.
Must fix
-
[bug]
unlockPathsdoes not exist
The package exportsunlockOwner(root, owner), notunlockPaths.
Current PR:import { lockPaths, unlockPaths, LOCKS_DIR } from '@cobusgreyling/loop-worktree/lock';
Correct (matches
tools/loop-worktree/README.mdanddist/lock.d.ts):import { lockPaths, unlockOwner, LOCKS_DIR } from '@cobusgreyling/loop-worktree/lock';
The GFI issue body also says
unlockPaths— that was a typo in the issue; implement against the real API.
Optional polish
- Show a one-liner usage after import, e.g.
await lockPaths({ root, owner, paths, ttl: '6h' })/await unlockOwner(root, owner), so readers see the function signatures. - CLI block already looks correct (
lock/unlock --owner).
Decision: request changes. Fix the import name, then this is a quick approve/merge.
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.
Summary
Changes
templates/pattern-template.md+ updatedregistry.yaml)Checklist (from CONTRIBUTING)
STATE.md*examples use.examplesuffixdocs/safety.mdnode tools/loop-audit/dist/cli.js .(or on the starter) and addressed findingsTesting / Dogfood
loop-auditpasses on affected starters or this repoScreenshots / Examples (if UI or command output)
This template enforces the high bar this reference is known for.