Skip to content

docs(guides): rename the read view to reach - #596

Merged
aicayzer merged 2 commits into
mainfrom
docs/reach
Oct 23, 2026
Merged

aicayzer merged 2 commits into
mainfrom
docs/reach

Conversation

@aicayzer

Copy link
Copy Markdown
Contributor

Summary

The pages that named the read view now call it the reach, matching withmarfa/marfa#2344 (the rename of the concept, the X-Marfa-Reach header, the reach_changed error code and the reach chapter of the contract). The generated files follow from the same marfa change. The same pull request also carries the one-line fix to the edge.updated row of the event table, which now says an event also fires when one of an edge's ends moves to another item.

Merge this after withmarfa/marfa#2344. Until that merges, the contract links to conformance/spec/reach.md point at a chapter main does not have yet.

Changes

  • Pages: the 409 reach_changed entry in Troubleshooting, the contract links in Keep a copy in sync and in Events, the key-change recovery in Sync a folder, and the Swift SDK page's example of a copyExpired reason.
  • Synced files: openapi.json, the glossary, the error codes, the event types and fields, the settings table and the contract index, written by scripts/sync-from-marfa.sh from the branch of #2344. The sync also brings in the glossary change that merged in marfa since the last sync.
  • Sync script and its test: the frame schema is now ReachChangedFrame.
  • Not changed: the Changelog's past releases, which describe what each release did under its name at the time. A change that has not shipped gets no entry.

Testing

  • pnpm test passes (39 files, 698 tests), including the content lint, the glossary check and the command check.
  • .github/scripts/sync-from-marfa.test.sh passes (615 checks).
  • Not run: pnpm build and pnpm types:check. The change touches no code under src/.

Notes for reviewers

  • The sync ran against the branch of #2344, not main. After #2344 merges, run the sync again from an up-to-date marfa main; it should change nothing.
  • The Swift SDK page names reach_changed as a reason. The SDK gets that name when its core pin moves to a release that includes #2344; the page is right from that release.
  • Review depth: a rename, with the generated files taken as written by the script.

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. (A rename: the existing tests cover it.)
  • Docs, comments and the contract still say what is true after this change.

@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. Renames the read view to reach in the docs pages and the synced files, after withmarfa/marfa#2344 merged; the sync from marfa main also picks up the event log retention default changed there.

First draft: 5/5. Nothing of consequence found.


Reviewed with codex review --base origin/main. This review may contain mistakes.

@aicayzer
aicayzer marked this pull request as ready for review October 23, 2026 20:11
@aicayzer
aicayzer merged commit a2a6fa7 into main Oct 23, 2026
5 checks passed
@aicayzer
aicayzer deleted the docs/reach branch October 23, 2026 20:11
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