Repository navigation
docs(folders): move the file format and the Mac app out of Sync a folder - #651
Merged
Merged
Conversation
1 task done
aicayzer
force-pushed
the
docs/chunk2-split-sync-a-folder
branch
from
October 25, 2026 17:08
a258b63 to
466f38c
Compare
aicayzer
force-pushed
the
docs/chunk2-split-sync-a-folder
branch
from
October 25, 2026 17:23
861271f to
982e74f
Compare
aicayzer
commented
Oct 25, 2026
aicayzer
left a comment
Contributor
Author
There was a problem hiding this comment.
Review: ready to merge
Summary. A docs copy and structure change. A fresh reviewer read it against the copy checklist (point first, clear, concise, no em dashes, facts true against the contract and code, right components, links and anchors current), and the fixes are in this branch.
Reviewed by withmarfa-reviewer. This review may contain mistakes.
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
Sync a folder was 2,359 words, past the 1,500-word guide limit. It covered setting a folder up, the file format, and maintenance in one page. It now holds the setup and the upkeep (1,450 words), and two new pages take what a reader looks up at another time.
This pull request builds on #650 (the tutorial changes to the same page). Review and merge #650 first.
Changes
/guides/folder-files, about 860 words): how an item appears as a file, files attached to a note, and how an edit on either side reaches the other. These sections moved unchanged apart from one pointer ("in the first step" now links to the key step)./guides/folder-from-a-mac-app): the Swift SDKFoldersexample, with a sentence to say it shares the Mac's folder list withmarfa folders.guides/meta.jsonafter Sync a folder. Links to the moved anchors (changelog, Folder safeguards) point at the new pages.Testing
pnpm test(content lint, link and anchor check, command check).Notes for reviewers
swift-sdk.mdx(docs(swift-sdk): say a replaced refused copy keeps its file budget #643) says Sync a folder "sets one up, with Swift examples". The Swift example now sits on the new Mac app page; the link still resolves, and the sentence is worth changing once docs(swift-sdk): say a replaced refused copy keeps its file budget #643 merges.catalog/edges.mdxlinks "synced folder" to Sync a folder; Files in a folder would be a closer target. Left alone to keep clear of the Catalog pull request.Checklist
STYLE.mdmeta.jsonupdated for each new page