docs: add 0.6 migration guide#83
Merged
Merged
Conversation
Covers every breaking change since v0.5.4: required defineDevframe metadata fields, the anonymous: auth RPC renames + opt-in enforcement, WS origin allowlisting, zigpty replacing the node-pty peer, StartedServer.wss -> .ws, and the removed devframe/utils/human-id. Also fixes a stale StartedServer.wss reference in standalone-cli.md.
✅ Deploy Preview for devfra ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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.
What
Adds a migration guide covering every breaking change since
v0.5.4(reviewed all 55 commits betweenv0.5.4and the current0.6.0-beta.2head, including the five!:commits):defineDevframenow requiresversion,packageName,homepage,descriptionanonymous:prefix, plus the new opt-in real-enforcementauth: DevframeAuthHandlerandallowedOriginscross-origin WS gatenode-ptypeer to bundledzigptyStartedServer.wssrenamed to.ws(thews→crosswstransport swap)devframe/utils/human-idremoved, withnanoid/crypto-tokenas replacementsWhere
docs/guide/migration-0.6.md, wired into the docs sidebar/navREADME.md(hosted docs URL + in-repo source path) so it's easy for humans and agents to discoverStartedServer.wssreference indocs/guide/standalone-cli.mdfound while researching the transport renameVerification
pnpm docs:buildpasses (VitePress fails the build on dead links — confirms every cross-reference in the new page resolves)pnpm eslintclean on all touched filesCreated with the help of an agent.