Skip to content

docs(skills): stamp the starter reference for magic_starter 0.0.59 and document the nav badge - #255

Merged
anilcancakir merged 2 commits into
masterfrom
docs/stamp-starter-0.0.59
Oct 28, 2026
Merged

anilcancakir merged 2 commits into
masterfrom
docs/stamp-starter-0.0.59

Conversation

@anilcancakir

@anilcancakir anilcancakir commented Oct 28, 2026 •

Copy link
Copy Markdown
Member

magic_starter 0.0.59 (fluttersdk/magic_starter#222, merged as 4f48304) adds a live count badge to MagicStarterNavItem. This page now documents it and names the new stamp: magic_starter's test/skill_reference_stamp_test.dart reads this file from magic's default branch and fails the 0.0.59 release PR until it says 0.0.59. No magic release is needed for that; the registry copy moves with magic's next release.

Merge order: this PR first, then the magic_starter 0.0.59 release PR (its CI reads this file).

What changed

All in skills/magic-framework/references/plugin-starter.md:

  • Stamp: <!-- magic_starter v0.0.59 | Updated: 2026-10-28 -->.
  • MagicStarterNavItem fields gain badgeCount (ValueListenable<int?>) and badgeLabelKey, with a new "A count on a destination (0.0.59+)" section: the shell listens to the notifier, hidden for null or not above zero, 99+ above 99, where it is drawn (labelled row, compact rail and bottom bar corner), the screen reader sentence read through transChoice with the real count, the nav.badge_count install stub key, and that an item holding a notifier is not const.
  • MagicStarterNavigationTheme.badgeClassName in the nav theme table and in the useNavigationTheme row.
  • MagicStarterNavBadge in the starter widgets table.
  • Opening paragraph, two wording changes that are not the badge:
    • "every sibling floor names the newest release at that point" becomes "names a release this package was verified against", which is what the floors actually are and matches plugin-deeplink.md.
    • The Wind floor it quotes moves to ^1.10.0. The page had quoted ^1.9.0 while the pubspec has carried ^1.9.1 since 0.0.49; the sentence now says so. Only the Wind floor moves in 0.0.59.

SKILL.md is not touched: its version moves at magic's release, as in #250 and #254.

Gates

  • dart format --output=none --set-exit-if-changed .: 0 changed of 482 files.
  • flutter analyze: no issues.
  • flutter test: 2361 passed, 1 skipped.

…d document the nav badge

magic_starter 0.0.59 (fluttersdk/magic_starter#222) adds a live count
badge to MagicStarterNavItem. The page now documents badgeCount,
badgeLabelKey, MagicStarterNavigationTheme.badgeClassName and
MagicStarterNavBadge, and names the 0.0.59 stamp that magic_starter's
skill_reference_stamp_test reads from this branch.

The Wind floor quoted in the opening paragraph follows the pubspec,
which moves from ^1.9.1 to ^1.10.0 in that release.
@codecov

codecov Bot commented Oct 28, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@kodizm

kodizm Bot commented Oct 28, 2026

Copy link
Copy Markdown

Note

Kodizm (AI-generated). May contain mistakes; verify before acting.

Docs-only change to one file; mostly solid, but one version claim in the new text contradicts what the file itself said a commit ago.

Major

skills/magic-framework/references/plugin-starter.md:5: the new sentence "0.0.59 moves only the Wind floor, from ^1.9.1 to the 1.10.0 on pub.dev" claims the prior floor was ^1.9.1, but the version this line replaces (the 0.0.58 stamp, git show HEAD~1:skills/magic-framework/references/plugin-starter.md) actually read fluttersdk_wind ^1.9.0, not ^1.9.1. This skill file is read by magic_starter's own CI gate and by LLM agents picking dependency floors, so a wrong "moved from X" claim is the kind of error that's meant to be caught here. Worth confirming which value (1.9.0 or 1.9.1) was the real prior pubspec floor before merging.

Minor

skills/magic-framework/references/plugin-starter.md:5: rewording "names the newest release at that point" to "names a release this package was verified against" is good — it now matches the phrasing already used in plugin-deeplink.md:310 — but it's an unrelated wording change riding along with the version stamp/badge update; worth calling out explicitly in the PR description rather than folding it into "Only the Wind floor moves in that release."

Tests

Documentation-only change (one markdown file); no test coverage applies. The nav-badge section, theme table, and widget table additions read consistently with the rest of the file (defaults like sidebarCompactWidth: 80 match existing docs elsewhere).

CI

All green on 379ce4c5: codecov/patch success, Lint & Test success, Generated code analyzes success, Auto-merge low-risk Dependabot PRs skipped (not applicable here). This is a markdown-only diff, so these checks don't exercise the new badge documentation itself — flag the Wind-floor accuracy above by inspection, not CI.

The page quoted fluttersdk_wind ^1.9.0 while magic_starter's pubspec has
carried ^1.9.1 since 0.0.49. State the pubspec's move to ^1.10.0 and
that the page was one step behind it, so the sentence cannot be read as
a claim about the old quote.
@anilcancakir

Copy link
Copy Markdown
Member Author

Both findings checked against the source, one fixed and one handled in the description. Head is now 6bce42c.

Major: the Wind floor claim (plugin-starter.md:5)

Verified. The claim "from ^1.9.1" is about magic_starter's pubspec, and that is right, but the page itself had quoted ^1.9.0, so the sentence read as a correction nobody could follow:

$ git show 0.0.58:pubspec.yaml | grep -n "fluttersdk_wind: "
92:  fluttersdk_wind: ^1.9.1
$ git log --oneline -S"fluttersdk_wind: ^1.9.1" -- pubspec.yaml     (magic_starter)
5b3490b release: 0.0.49 (#202)
$ git show HEAD~1:skills/magic-framework/references/plugin-starter.md | sed -n 5p | grep -o "fluttersdk_wind \^[0-9.]*"
fluttersdk_wind ^1.9.0

So the pubspec floor was ^1.9.1 from 0.0.49 and the page lagged at ^1.9.0. Fixed in 6bce42c: the sentence now reads "0.0.59 moves only the Wind floor, in the pubspec from ^1.9.1 to ^1.10.0. This page quoted ^1.9.0 until then, a floor the pubspec left at 0.0.49." The quoted floor on the same line is ^1.10.0.

Minor: the wording change riding along

Agreed and not a code change: "names the newest release at that point" became "names a release this package was verified against" in 379ce4c. The PR description now lists it, and the Wind floor correction above, as their own bullets under "Opening paragraph, two wording changes that are not the badge".

Gates on 6bce42c

  • dart format --output=none --set-exit-if-changed .: Formatted 482 files (0 changed)
  • Markdown only since the last full run (flutter analyze: no issues, flutter test: 2361 passed, 1 skipped, both on 379ce4c).

@kodizm please re-review.

@kodizm

kodizm Bot commented Oct 28, 2026

Copy link
Copy Markdown

Note

Kodizm (AI-generated). May contain mistakes; verify before acting.

Both prior findings are resolved; this looks good to merge.

Re-reviewed the diff between 379ce4c5 and head 6bce42c (one line changed).

The Wind-floor sentence now reads: "0.0.59 moves only the Wind floor, in the pubspec from ^1.9.1 to ^1.10.0. This page quoted ^1.9.0 until then, a floor the pubspec left at 0.0.49." That correctly separates the pubspec's real floor history from the page's own lag, matching what git show 0.0.49:pubspec.yaml and the page's prior text show. No remaining contradiction.

The wording-change finding (minor) was addressed by updating the PR description to call it out as its own bullet, which is sufficient.

No new findings on this incremental change — it's a one-line prose fix, no code or badge-doc content touched.

Tests

Documentation-only change; no test coverage applies, as before.

CI

All green on 6bce42c: codecov/patch success, Lint & Test success, Generated code analyzes success, Auto-merge low-risk Dependabot PRs skipped (not applicable).

@anilcancakir
anilcancakir merged commit f574814 into master Oct 28, 2026
5 checks passed
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