docs: Move the escrow example off the package versioning page - #27912
Open
jessiemongeon1 wants to merge 2 commits into
Open
docs: Move the escrow example off the package versioning page#27912jessiemongeon1 wants to merge 2 commits into
jessiemongeon1 wants to merge 2 commits into
Conversation
Package Versioning states its goal as "Reader understands versioning provides the ability to upgrade packages on the Sui network". Lines 1 to 75 did that: user package versions, framework package versions, manifest versions. Lines 76 to 231 were an escrow swap example comparing address-owned objects against a shared object, which never mentioned packages, versions, or upgrades, and the page ended without returning to the subject. 67% of the page was about something else. Moved it to develop/objects/escrow-example.mdx, next to the other Using Objects pages, retitled "Owned Compared With Shared Objects" after what it actually teaches. Nothing links to the section, so no inbound links break. Two fixes that fall out of the split: The ### headings on both pages had no ## parent, which breaks the table of contents nesting. Each page's sections are now ##. The versioning intro said package inputs "are always loaded at their latest version". The User packages section directly below it says the opposite, that all versions "remain callable, including v1 even after v3 exists". The claim also produced a wrong sentence on upgrade.mdx earlier in this audit, which review caught. It now says inputs are referenced by ID alone with no separate version number, and the 2 subsections explain what that means for user and framework packages. Also repointed the lock.move link, which used a pinned SHA against examples/move/escrow, a path that has since moved to examples/trading/contracts/escrow.
jessiemongeon1
deployed
to
sui-typescript-aws-kms-test-env
September 8, 2026 19:21 — with 
GitHub Actions
Active
GitHub Actions
Active
|
The latest updates on your projects. Learn more about Vercel for GitHub.
2 Skipped Deployments
|
github-actions
Bot
added
the
Type: Documentation
jessiemongeon1
changed the title
jessiemongeon1
marked this pull request as ready for review
September 8, 2026 19:24
jessiemongeon1
deployed
to
sui-typescript-aws-kms-test-env
September 8, 2026 19:24 — with
GitHub Actions
Active
GitHub Actions
Active
Contributor
Author
Style Guide AuditAll 2 file(s) pass the style guide audit. |
Line 48 was genuinely passive. Gave it a subject rather than taking the suggested wording, because "inputs use ID alone" reads oddly: an input does not use an ID, a transaction identifies it by one. It now reads "A transaction references a package input by ID alone", which also matches how MystenLabs#27910 phrases the same idea on upgrade.mdx. Line 64 is not passive. "Their IDs must remain stable" uses remain as a linking verb, and the suggested "must stay stable" is equally active, so the swap changes register rather than voice. Took it anyway, as "stay the same", since it costs nothing and reads slightly plainer.
jessiemongeon1
deployed
to
sui-typescript-aws-kms-test-env
September 8, 2026 21:11 — with
GitHub Actions
Active
GitHub Actions
Active
tnowacki
approved these changes
Sep 8, 2026
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
2 participants
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.
Description
develop/publish-upgrade-packages/versioning.mdxstates its goal as "Reader understands versioning provides the ability to upgrade packages on the Sui network."Lines 1–75 delivered that: user package versions, framework package versions, manifest versions.
Lines 76–231 were an escrow swap example comparing address-owned objects against a shared object, under headings
Fastpath: address-owned objectsandConsensus: shared object. It never mentioned packages, versions, or upgrades, and the page ended without returning to the subject. 67% of a page about package versioning was about something else.Moved it to
develop/objects/escrow-example.mdx, next to the other Using Objects pages, retitled Owned Compared With Shared Objects after what it actually teaches. Nothing linked to that section, so no inbound links break.develop/objects/versioning.mdxcovers the same ownership distinction conceptually, so the example now sits with its subject.Test plan
ImportContentsources on the new page resolve.sidebars.jsparses, new page added under Using Objects.