Skip to content

docs(run): bring deploy, folder and export guides under their limit - #756

Merged
aicayzer merged 5 commits into
mainfrom
docs/run-guides-to-limit
Nov 1, 2026
Merged

aicayzer merged 5 commits into
mainfrom
docs/run-guides-to-limit

Conversation

@aicayzer

@aicayzer aicayzer commented Oct 31, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Deploy, Sync a folder and Export and restore are rewritten under the 1,500-word guide limit, and their ceilings are removed. Deploy and Install now say to turn off Cloudflare's Email Address Obfuscation, which otherwise shows every email address on an instance's pages as [email protected].

Closes #734

Part of #721: Export and restore names the icon rule; the connector example's icon ID is in #759, which closes it.

Changes

  • Deploy (1,498 words, was 1,731): the private socket section keeps what the server needs (where the socket is, MARFA_CONTROL_SOCKET, the folder's owner, acl, a stale socket) and links to the CLI page for the commands. "The address" gains the Cloudflare paragraph: the dashboard's Security > Settings, or a Configuration Rule setting Email Obfuscation off for one hostname. The data directory points to Back up and restore for Litestream's files instead of repeating them; the "where it can run" table loses a column.
  • CLI, Use the private socket: gains the table of commands that need the socket, the 401/exit 5 rule and the variables to unset (2,252 words, limit 3,000).
  • Install: one sentence for the cloudflare choice, linking to Deploy.
  • Sync a folder (1,500, was 1,668): the git-ignored directory advice, the first_placement and backref refusals and the newer-CLI section are tightened. The instruction to repair a folder that still stores search on a pre-v0.0.33 server is removed.
  • Export and restore (1,495, was 1,612): "trash" becomes "bin"; restoring through the socket links to the CLI page; the type icon counts and blobs_missing are shortened, and an icon the pinned icon sets refuse is skipped as unknown_icon (search-and-filters/restore-type-icons-skipped), linking to the icon rule; "Check two fields" now says "these fields", since there are three.
  • page-limits.json: ceilings removed for all three.

Testing

  • pnpm test: 770 passed.
  • pnpm build and pnpm exec vite preview: Deploy and the CLI socket section looked at at 375 px with no sideways scroll; Deploy's .md copy carries the Cloudflare paragraph.
  • Checked against marfa v0.0.50: GET /export leaves out only the bin by default (packages/server/src/routes/export.ts, openapi.json), the type move's folder rewrite (types.md, the rule at line 1011), MARFA_CONTROL_SOCKET (config.ts). The Cloudflare steps were checked against Cloudflare's Email Address Obfuscation and Configuration Rules settings pages.

Notes for reviewers

The search repair note went because Marfa keeps nothing for compatibility before its first release.

Checklist

  • The title is a scoped Conventional Commit.
  • New behavior has a test that was seen failing first, or no test was needed and the reason is above.
  • Docs, comments and the contract still say what is true after this change.

@aicayzer
aicayzer merged commit a640652 into main Nov 1, 2026
8 checks passed
@aicayzer
aicayzer deleted the docs/run-guides-to-limit branch November 1, 2026 00:37
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.

Say that Cloudflare's email obfuscation must be off for an instance's address

1 participant