Skip to content

Match NuGet order of RelNotes; detailed h2 headings#3757

Merged
mikehoffms merged 13 commits intomainfrom
user/mikehoffms/prerelease-before-release
Mar 20, 2026
Merged

Match NuGet order of RelNotes; detailed h2 headings#3757
mikehoffms merged 13 commits intomainfrom
user/mikehoffms/prerelease-before-release

Conversation

@mikehoffms
Copy link
Copy Markdown
Collaborator

@mikehoffms mikehoffms commented Mar 18, 2026

Rendered article sections for review:


Incidental files


About this PR

  • Moves the RelNotes h2 sections into a different sequence, that matches NuGet.
    • Doesn't change the content of wv2 RelNotes entries.
  • Adds the details to all of the h2 headings, that are needed in order to maximally facilitate maintenance and Content Development.
    • Required for the maintainers' context, which includes VS Code > the Primary Side Bar > the Explorer view > the Outline view.
    • The headings need to be clear, not obscure. Maintainers needs to see, explicitly and immediately:
      • Whether a Release or Prerelease. (Not consistently shown in NuGet's list after you click Load more; doesn't say "Release".)
      • The version number. (Shown in NuGet's list.)
      • The Runtime version. (Not shown in NuGet's list.)
      • The release date. (Shown in NuGet's list.)
    • Facilitating maintenance and Content Development is a top priority for the complicated RelNotes process.
  • Adds 5 missing h2 sections.
  • Adds a standard comment at end of each h2 section, to facilitate maintenance & Content Development.
  • Moves "About release notes for the WebView2 SDK" from top to bottom of the "Release notes" TOC bucket.
    • It's in the way, and unnecessarily forces conscious thinking about which of the 3 articles contain the promised relnotes, every time you nav.

To do when merge this PR

  • Update relnotes links in WebView2Announcements Issues.
    • Including 1-2 years ago, where users are taken to index.md (no auto-scroll to anchor; end up at top of page) but have to nav to archive.md instead, eg. SDK Release: 1.0.3079-prerelease.
    • While that's not done after merging this PR, the resulting UX will be:
      • Past year: No auto-scroll to anchor; end up at top of page; must select the heading in "In this article" nav.
      • Over 1 year ago: Users are taken to index.md, but have to nav to archive.md instead, and then select the heading in "In this article" nav.

Demonstration that section content is unchanged

Prerelease SDK 1.0.3415-prerelease, for Runtime 140 (Jul. 14, 2025)

Prerelease SDK 1.0.3171-prerelease, for Runtime 135 (Mar. 10, 2025)

Release SDK 1.0.1245.22, for Runtime 102 (Jun. 14, 2022)

AB#61473319

@mikehoffms mikehoffms added the cat: webview2 WebView-related content. label Mar 18, 2026
@mikehoffms mikehoffms changed the title Put Prerelease above Release, verbose h2 headings Prerelease RelNotes above Release; verbose h2 headings Mar 18, 2026
@mikehoffms mikehoffms changed the title Prerelease RelNotes above Release; verbose h2 headings Order RelNotes to match NuGet; verbose h2 headings Mar 18, 2026
@mikehoffms mikehoffms changed the title Order RelNotes to match NuGet; verbose h2 headings Match NuGet order of RelNotes; verbose h2 headings Mar 18, 2026
@mikehoffms mikehoffms changed the title Match NuGet order of RelNotes; verbose h2 headings Match NuGet order of RelNotes; detailed h2 headings Mar 18, 2026
Copy link
Copy Markdown
Collaborator Author

@mikehoffms mikehoffms left a comment

Choose a reason for hiding this comment

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

LGTM - Writer/Editor

Copy link
Copy Markdown
Contributor

@captainbrosset captainbrosset left a comment

Choose a reason for hiding this comment

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

Let's make sure to update the webview2announcements links as soon as possible after merging.

@learn-build-service-prod
Copy link
Copy Markdown

@mikehoffms mikehoffms merged commit d027b87 into main Mar 20, 2026
3 checks passed
@mikehoffms mikehoffms deleted the user/mikehoffms/prerelease-before-release branch March 20, 2026 19:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cat: webview2 WebView-related content.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants