Skip to content

docs: document public loop-worktree lock import in QUICKSTART (#426) - #433

Open
AIMindCrafter wants to merge 1 commit into
cobusgreyling:mainfrom
AIMindCrafter:docs/add-worktree-lock-quickstart
Open

docs: document public loop-worktree lock import in QUICKSTART (#426)#433
AIMindCrafter wants to merge 1 commit into
cobusgreyling:mainfrom
AIMindCrafter:docs/add-worktree-lock-quickstart

Conversation

@AIMindCrafter

Copy link
Copy Markdown
Contributor

Summary

Changes

  • New pattern or starter (followed templates/pattern-template.md + updated registry.yaml)
  • Doc / example improvement
  • Tool change (loop-audit)
  • Story (includes real failure or surprise + lesson)

Checklist (from CONTRIBUTING)

  • All required sections present for patterns
  • Links work from README, patterns/README, starters/README, docs/index
  • No secrets, tokens, internal company URLs
  • STATE.md* examples use .example suffix
  • Safety-related content references docs/safety.md
  • Ran node tools/loop-audit/dist/cli.js . (or on the starter) and addressed findings

Testing / Dogfood

  • loop-audit passes on affected starters or this repo
  • Manual review of generated state / skill output

Screenshots / Examples (if UI or command output)


This template enforces the high bar this reference is known for.

@github-actions

Copy link
Copy Markdown
Contributor

Thanks @AIMindCrafter for contributing a docs improvement — visible, reviewable PRs like this grow the reference for everyone.

What happens next

  • Maintainer aims for same-day review on story, adopter, and scoped docs/example PRs (CONTRIBUTING.md).
  • good first issue PRs: comment on the linked issue so we can assign and close on merge.

More ways to help

— loop-engineering maintainers

@cobusgreyling cobusgreyling left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

  1. [bug] unlockPaths does not exist
    The package exports unlockOwner(root, owner), not unlockPaths.
    Current PR:

    import { lockPaths, unlockPaths, LOCKS_DIR } from '@cobusgreyling/loop-worktree/lock';

    Correct (matches tools/loop-worktree/README.md and dist/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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants