docs: add loop-sync subsection to QUICKSTART#263
Merged
cobusgreyling merged 1 commit intoJul 13, 2026
Conversation
Document loop-sync drift detection between STATE.md and LOOP.md in the Quickstart, after the audit step. Includes the npx command, real sample output with interpretation, when to run it (after editing LOOP.md, before scheduling an L2 loop), and a link to tools/loop-sync/README.md. Also adds loop-sync to the copy-paste cheat sheet. Closes cobusgreyling#226 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
|
Thanks @a-yeyang 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 |
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
2 participants
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.
Closes #226.
Adds a
loop-syncsubsection todocs/QUICKSTART.md, placed right after the audit step (section 4), so newcomers learn to catchSTATE.md↔LOOP.mddrift before scheduling a loop on stale instructions.Acceptance criteria (from #226)
npx @cobusgreyling/loop-sync .with sample output + interpretationLOOP.md, before scheduling L2)tools/loop-sync/README.mdNotes
loop-syncagainst a freshloop-init --pattern daily-triagescaffold (80/100, two warnings), not hand-written.>=70healthy /40–69warning /<40critical intools/loop-sync/src/sync.ts), which is why the80/100sample reads(healthy).loop-syncline to the copy-paste cheat sheet for parity with the other tools.validate-registry✓ andcheck-loop-init-sync✓ still pass; onlydocs/QUICKSTART.mdis changed; thetools/loop-sync/README.mdlink target exists.PR checklist
STATE.mdexamples use.examplesuffix (n/a — no state files added)