Skip to content

docs(release): align the docs with marfa v0.0.28 - #593

Merged
aicayzer merged 1 commit into
mainfrom
docs/release-v0.0.28
Oct 23, 2026
Merged

aicayzer merged 1 commit into
mainfrom
docs/release-v0.0.28

Conversation

@aicayzer

Copy link
Copy Markdown
Contributor

Summary

Syncs the docs with Marfa v0.0.28 (tag v0.0.28, commit 41fc3dd4c). The release has one change, marfa#2322: a bound file that is missing when a folder pass's pull reaches its item is no longer written back, so a file you move keeps its item and a file you delete reaches the bin. The folder watch runs in the CLI, so the CLI needs the upgrade for the fix. There is no database, API or working-copy change. This pull request moves the generated files to 0.0.28, adds the changelog entry and checks the pages from #592 against the code and the new contract rules at the tag.

Changes

  • Synced from the v0.0.28 tag only: marfa-release.json, cli-download.md and server-image.md move to 0.0.28, and contract-index.json gains the four new rules in the folders chapter (folders/delete-before-first-write, folders/pull-missing-file-not-written, folders/pull-missing-file-unwritten-count, folders/pull-missing-file-moved-keeps-item). openapi.json, cli-commands.json and the rest of src/generated/ are unchanged.
  • changelog.mdx: v0.0.28 entry. It says the fix is in the folder watch, that the CLI must be upgraded for it, and that no export is needed to upgrade.
  • No page change beyond the changelog: the delete row and the new move row in Folder safeguards (docs(guides): say a running sync never writes back a moved or deleted file #592) match the code and the contract at the tag.

Testing

  • pnpm test: 698 tests pass in 39 files, including the content lint, link checks and the CLI command check.
  • pnpm build, pnpm build:status and pnpm types:check pass.
  • sync-from-marfa.test.sh: 615 passed.
  • The sync ran from a worktree of marfa at the tag.
  • Read against the tag: the diff of v0.0.27 to v0.0.28 (core/marfa-core/src/folder/pull.rs, scan.rs, removal.rs, watch.rs), the four new rules in conformance/spec/folders.md, delete-grace and delete-remote-revives, and the CLI's report lines for an unwritten file (core/marfa-cli/src/folders.rs). The five-second grace is RENAME_GRACE. The staleness report between the v0.0.27 and v0.0.28 syncs names no page that cites a changed rule, and six pages that link the folders chapter; the pages that mention moves or deletes (Folder safeguards, Sync a folder, Keep folders running, the folder watch record, Devices, the Swift SDK) were read and none contradicts the code.
  • Not tested: no CLI or folder was run. Every statement about folder behavior was read from the code and the contract, not run against a folder.

Notes for reviewers

  • The exception in the changelog (a file gone from a path a scan no longer reaches is still written where its item wants it) is from the contract reason of folders/pull-missing-file-not-written and pull.rs. Folder safeguards does not state it, because it only arises when the folder's lists change during a pass.
  • No file of docs(guides): add the Google Cloud project guide for Google connectors #590 is touched.
  • Review depth: checks only.

Checklist

  • The title is a scoped Conventional Commit.
  • No test was needed: prose and synced files only.
  • Docs, comments and the contract still say what is true after this change.

@aicayzer
aicayzer marked this pull request as ready for review October 23, 2026 03:04
@aicayzer
aicayzer enabled auto-merge (squash) October 23, 2026 03:04
@aicayzer
aicayzer merged commit 819a419 into main Oct 23, 2026
7 checks passed
@aicayzer
aicayzer deleted the docs/release-v0.0.28 branch October 23, 2026 03:07
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