Skip to content

docs: Add migration guide for upgrading to Serverpod 3.5#563

Merged
developerjamiu merged 9 commits into
mainfrom
docs/migrate-to-three-five-guide
Jun 3, 2026
Merged

docs: Add migration guide for upgrading to Serverpod 3.5#563
developerjamiu merged 9 commits into
mainfrom
docs/migrate-to-three-five-guide

Conversation

@developerjamiu
Copy link
Copy Markdown
Contributor

@developerjamiu developerjamiu commented Jun 1, 2026

Closes #537.

Adds a guide for upgrading an existing 3.4 project to 3.5 (Jetstream), covering the CLI bump, dependency pin, SDK constraint, schema migration, the new serverpod start workflow (with both embedded Postgres and Docker paths), agent skills, production-deployment notes, and a curated "What's new in 3.5".

Files

  • New content: docs/11-upgrading/01-upgrade-to-three-five.md.
  • One inbound-link update: the Vector fields concept page links to the pgvector upgrade page; its path was adjusted to follow the move into the archive.
  • Everything else is restructure (git renames, no content changes): the existing upgrade pages move into 02-archive/ (renamed from 04-archive/), and the archive is reordered chronologically (oldest first) so 1.2 → 2.0 → mini → 2.2 → pgvector → 3.0 reads in the order they were created. The latest upgrade page (01-upgrade-to-three-five.md) sits at the top of the section to match the convention of "latest first" for the active upgrade.

The new 3.5 guide pins to 3.5.0-beta.9 while 3.5 is in beta.

Verification

npm run build passes locally with no broken links.

@developerjamiu developerjamiu self-assigned this Jun 1, 2026
@developerjamiu developerjamiu added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 1, 2026
@developerjamiu developerjamiu requested a review from Swiftaxe June 1, 2026 14:09
@Swiftaxe Swiftaxe requested a review from Copilot June 1, 2026 15:04
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new upgrade guide for moving Serverpod projects from 3.4 → 3.5 (Jetstream), and reorganizes older upgrade guides into a chronological archive while updating one inbound link to the pgvector upgrade page.

Changes:

  • Add a new “Upgrade to 3.5” migration guide covering CLI/dependencies, migrations, serverpod start, embedded Postgres vs Docker, agent skills, and deployment notes.
  • Move existing upgrade guides into docs/11-upgrading/02-archive/ and reorder them chronologically.
  • Update the Vector fields concept doc to point to the archived pgvector upgrade guide, and update the pgvector guide’s migration link.

Reviewed changes

Copilot reviewed 3 out of 9 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
docs/11-upgrading/01-upgrade-to-three-five.md New step-by-step upgrade guide for Serverpod 3.5.
docs/11-upgrading/02-archive/01-upgrade-to-one-point-two.md Archived 1.2 upgrade guide after archive restructure.
docs/11-upgrading/02-archive/02-upgrade-to-two.md Archived 2.0 upgrade guide after archive restructure.
docs/11-upgrading/02-archive/03-upgrade-from-mini.md Archived Mini → full upgrade guide after archive restructure.
docs/11-upgrading/02-archive/04-upgrade-to-two-point-two.md Archived 2.2 upgrade guide after archive restructure.
docs/11-upgrading/02-archive/05-upgrade-to-pgvector.md Archived pgvector upgrade guide with updated migrations link.
docs/11-upgrading/02-archive/06-upgrade-to-three.md Archived 3.0 upgrade guide after archive restructure.
docs/11-upgrading/02-archive/category.json New archive category metadata for the upgrading section.
docs/06-concepts/02-models/03-vector-fields.md Update link to the pgvector upgrade guide in its new archived location.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/11-upgrading/01-upgrade-to-three-five.md Outdated
Comment thread docs/11-upgrading/01-upgrade-to-three-five.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copy link
Copy Markdown
Collaborator

@marcelomendoncasoares marcelomendoncasoares left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work on the docs, @developerjamiu! Made some suggestions for improvement/completeness and only small corrections on the behavior of the features.

Comment thread docs/06-concepts/02-models/03-vector-fields.md Outdated
Comment thread docs/11-upgrading/01-upgrade-to-three-five.md
Comment thread docs/11-upgrading/01-upgrade-to-three-five.md Outdated
Comment thread docs/11-upgrading/01-upgrade-to-three-five.md Outdated
Comment thread docs/11-upgrading/01-upgrade-to-three-five.md Outdated
Comment thread docs/11-upgrading/01-upgrade-to-three-five.md Outdated
Comment thread docs/11-upgrading/01-upgrade-to-three-five.md Outdated
Comment thread docs/11-upgrading/01-upgrade-to-three-five.md
Comment thread docs/11-upgrading/01-upgrade-to-three-five.md Outdated
Comment thread docs/11-upgrading/01-upgrade-to-three-five.md Outdated
Copy link
Copy Markdown
Collaborator

@Swiftaxe Swiftaxe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks really neat!

Added a couple of minor comments.

Comment thread docs/11-upgrading/02-archive/01-upgrade-to-one-point-two.md
Comment thread docs/11-upgrading/01-upgrade-to-three-five.md
Copy link
Copy Markdown
Collaborator

@marcelomendoncasoares marcelomendoncasoares left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a few comments more, but feel free to address or ignore as you consider relevant!

Comment thread docs/11-upgrading/01-upgrade-to-three-five.md Outdated
Comment thread docs/11-upgrading/01-upgrade-to-three-five.md
Comment thread docs/11-upgrading/01-upgrade-to-three-five.md Outdated
Comment thread docs/11-upgrading/01-upgrade-to-three-five.md Outdated
Copy link
Copy Markdown
Collaborator

@marcelomendoncasoares marcelomendoncasoares left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 🚀

@developerjamiu developerjamiu merged commit b8d6e5e into main Jun 3, 2026
4 checks passed
@developerjamiu developerjamiu deleted the docs/migrate-to-three-five-guide branch June 3, 2026 16:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add migration guide for 3.5 Jetstream

4 participants