Skip to content

docs: make Flutter Versions a general Flutter reference - #632

Merged
eseidel merged 1 commit into
mainfrom
docs/flutter-versions-reference
Aug 27, 2026
Merged

docs: make Flutter Versions a general Flutter reference#632
eseidel merged 1 commit into
mainfrom
docs/flutter-versions-reference

Conversation

@eseidel

@eseidel eseidel commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

Status

READY

Description

/getting-started/flutter-version/ ranks around position 8 for the "what Flutter version is current" query cluster, but the page answers a Shorebird-specific question instead. This restructures it so the top half is useful to any Flutter developer and the Shorebird material sits below it.

Page

  • Leads with the current stable release in a callout, as one plain sentence rather than a stat block, so a search engine or assistant can lift it directly.
  • Tightened the recommendation prose to three short paragraphs: latest stable, run the newest patch of whatever you're on, and the one-release-behind case that large enterprises use.
  • New release table — newest patch of each recent release, its Dart SDK version, when it first shipped, and the headline changes it brought. Five rows show by default with a "Show 5 older releases" toggle. All ten rows ship in the HTML and collapse client-side, so crawlers and assistants read the whole table and it degrades to fully expanded with JS off.
  • Existing Shorebird version notes are unchanged, now under a new "Shorebird and Flutter versions" heading. #supported-flutter-versions and #use-a-different-flutter-version keep their ids — Google indexes both as separate results.

Data

  • scripts/update-flutter-releases.mjs merges Flutter's three platform release feeds into src/data/flutter-releases.json (one row per release, newest patch, Dart version, dates). Run it with npm run update-flutter-releases. No generation timestamp, so a no-op run produces no diff.
  • .github/workflows/flutter-releases.yaml runs daily and fails when the committed file has fallen behind stable, with a message naming the new version. It does not open a PR. Both paths were exercised locally.
  • Highlights are hand-written in src/data/release-highlights.ts, summarized from Flutter's own release announcements — the feeds carry versions and dates but nothing about what changed. A release with no entry renders a dash.

Note that this is all separate from src/consts.ts, which tracks the Flutter version Shorebird ships and is still bumped by hand. The page distinguishes the two.

Checks

npm run build, format:check, cspell, Vale, and the component-label lint all pass locally. Verified the table and callout in light and dark, and the toggle in a browser.

Follow-ups, not in this PR

  • Per-release "known issues" commentary sourced from the version-quality data in the admin dashboard, rather than the static notes list.
  • Disclosure triangles for per-release detail — the data is already keyed per release.

@eseidel
eseidel requested a review from dawn-ducky August 25, 2026 23:44
@eseidel
eseidel enabled auto-merge (squash) August 25, 2026 23:44
The page ranks around position 8 for the "what Flutter version is
current" query cluster but answered a Shorebird-specific question
instead. Restructure it so the top half is useful to any Flutter
developer and the Shorebird-specific material moves below it.

- Lead with the current stable release, in a callout, as one plain
  sentence that a search engine or assistant can lift directly.
- Add a table of the newest patch of each recent release, with its Dart
  SDK version, release date, and headline changes. Five rows show by
  default; all ten ship in the HTML so crawlers read the whole table.
- Generate the version data from Flutter's release feeds into
  src/data/flutter-releases.json via `npm run update-flutter-releases`.
  A daily workflow fails the build when it falls behind stable.
- Keep the existing Shorebird version notes, unchanged, under a new
  "Shorebird and Flutter versions" heading. The two section anchors
  Google indexes separately keep their ids.

Highlights are hand-written in src/data/release-highlights.ts, since the
feeds carry no information about what changed.
@AbhishekDoshi26
AbhishekDoshi26 force-pushed the docs/flutter-versions-reference branch from 89a32bd to 3c5dedc Compare August 27, 2026 07:06

@AbhishekDoshi26 AbhishekDoshi26 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM 👍🏻

@eseidel
eseidel merged commit cdfe062 into main Aug 27, 2026
5 checks passed
@eseidel
eseidel deleted the docs/flutter-versions-reference branch August 27, 2026 07:08
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.

2 participants