Skip to content

docs(folders): move the file format and the Mac app out of Sync a folder - #651

Merged
aicayzer merged 2 commits into
mainfrom
docs/chunk2-split-sync-a-folder
Oct 25, 2026
Merged

aicayzer merged 2 commits into
mainfrom
docs/chunk2-split-sync-a-folder

Conversation

@aicayzer

Copy link
Copy Markdown
Contributor

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

  • New Files in a folder (/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).
  • New Use a folder from a Mac app (/guides/folder-from-a-mac-app): the Swift SDK Folders example, with a sentence to say it shares the Mac's folder list with marfa folders.
  • Sync a folder keeps the four steps, then settings changes, replacing a key, a newer CLI and stopping. It points at the two new pages. I kept those sections here because Troubleshooting, Devices and the changelog link to their anchors. A few sentences are tighter; no fact is dropped, and a case Troubleshooting already covers is now a link.
  • Both new pages are in guides/meta.json after 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).
  • Looked at all three pages in the browser.

Notes for reviewers

Checklist

  • Follows STYLE.md
  • meta.json updated for each new page
  • Tests pass

@aicayzer
aicayzer force-pushed the docs/chunk2-split-sync-a-folder branch from a258b63 to 466f38c Compare October 25, 2026 17:08
@aicayzer
aicayzer changed the base branch from docs/chunk2-tutorials to main October 25, 2026 17:16
@aicayzer
aicayzer force-pushed the docs/chunk2-split-sync-a-folder branch from 861271f to 982e74f Compare October 25, 2026 17:23

@aicayzer aicayzer left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

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.

@aicayzer
aicayzer marked this pull request as ready for review October 25, 2026 17:25
@aicayzer
aicayzer merged commit 7ff180a into main Oct 25, 2026
7 checks passed
@aicayzer
aicayzer deleted the docs/chunk2-split-sync-a-folder branch October 25, 2026 17:27
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.

1 participant