Add migration link changelog

CHANGELOG.md

@@ -1,5 +1,7 @@
 # Changelog
 
+[Link to all migration guides](https://yew.rs/docs/category/migration-guides)
+
 ## ✨ yew **0.21.0** *(2023-09-23)*
 
 #### Changelog

tools/changelog/src/write_changelog_file.rs

@@ -20,7 +20,8 @@ pub fn write_changelog(changelog_path: &str, version_changelog: &[u8]) -> Result
 
     new_changelog.write_all(version_changelog)?;
 
-    for old_line in old_changelog_reader.lines().skip(2) {
+    // The `.skip` skips the title and link to the migration guide
+    for old_line in old_changelog_reader.lines().skip(4) {
         writeln!(new_changelog, "{}", old_line?)?;
     }
 

tools/changelog/src/write_version_changelog.rs

@@ -17,6 +17,12 @@ pub fn write_changelog_file(
     writeln!(version_only_changelog, "# Changelog")?;
     writeln!(version_only_changelog)?;
 
+    writeln!(
+        version_only_changelog,
+        "[Link to all migration guides](https://yew.rs/docs/category/migration-guides)"
+    )?;
+    writeln!(version_only_changelog)?;
+
     writeln!(
         version_only_changelog,
         "## ✨ {package} **{next_version}** *({release_date})* Changelog",

tools/changelog/tests/generate_yew_changelog_file.rs

@@ -62,7 +62,7 @@ fn generate_yew_changelog_file() -> Result<()> {
     let lines = expected_reader_lines.zip(after_reader_lines);
 
     for (i, (expected_line, after_line)) in lines.enumerate() {
-        if i == 2 || i == 13 {
+        if i == 4 || i == 15 {
             // these lines have dynamic things that may break the tests
             let expected_line_updated = expected_line?.replace(
                 "date_goes_here",

tools/changelog/tests/test_base.md

@@ -1,5 +1,7 @@
 # Changelog for its generation tests
 
+[Link to all migration guides](https://yew.rs/docs/category/migration-guides)
+
 ## ✨ yew **0.19.0** *(2021-11-26)*
 
 #### Changelog

tools/changelog/tests/test_expected.md

@@ -1,21 +1,23 @@
 # Changelog
 
+[Link to all migration guides](https://yew.rs/docs/category/migration-guides)
+
 ## ✨ yew **0.0.0** *(date_goes_here)* Changelog
 
 ### ⚡️ Features
 
-- Incremental performance improvements to element creation. [[@Greg Johnston](https://github.com/Greg Johnston), [#3169](https://github.com/yewstack/yew/pull/3169)]
+- Incremental performance improvements to element creation. [[@Greg Johnston](https://github.com/gbj), [#3169](https://github.com/yewstack/yew/pull/3169)]
 
 ### 🚨 Breaking changes
 
-- Enable PartialEq for all virtual dom types. [[@Kaede Hoshikawa](https://github.com/Kaede Hoshikawa), [#3206](https://github.com/yewstack/yew/pull/3206)]
-- Pass hook dependencies as the first function argument. [[@Arniu Tseng](https://github.com/Arniu Tseng), [#2861](https://github.com/yewstack/yew/pull/2861)]
+- Enable PartialEq for all virtual dom types. [[@Kaede Hoshikawa](https://github.com/futursolo), [#3206](https://github.com/yewstack/yew/pull/3206)]
+- Pass hook dependencies as the first function argument. [[@Arniu Tseng](https://github.com/arniu), [#2861](https://github.com/yewstack/yew/pull/2861)]
 
 ## ✨ yew **0.0.0** *(date_goes_here)* Changelog
 
 ### 🛠 Fixes
 
-- Fix defaulted type parameter.. [[@Kaede Hoshikawa](https://github.com/Kaede Hoshikawa), [#2284](https://github.com/yewstack/yew/pull/2284)]
+- Fix defaulted type parameter.. [[@Kaede Hoshikawa](https://github.com/futursolo), [#2284](https://github.com/yewstack/yew/pull/2284)]
 
 ### ⚡️ Features
 

website/i18n/ja/docusaurus-plugin-content-docs/current.json

@@ -82,5 +82,21 @@
   "sidebar.docs.category.Struct Components": {
     "message": "Struct Components",
     "description": "The label for category Struct Components in sidebar docs"
+  },
+  "sidebar.docs.category.Migration guides.link.generated-index.title": {
+    "message": "Migration guides",
+    "description": "The generated-index page title for category Migration guides in sidebar docs"
+  },
+  "sidebar.docs.category.yew.link.generated-index.title": {
+    "message": "yew",
+    "description": "The generated-index page title for category yew in sidebar docs"
+  },
+  "sidebar.docs.category.yew-agent.link.generated-index.title": {
+    "message": "yew-agent",
+    "description": "The generated-index page title for category yew-agent in sidebar docs"
+  },
+  "sidebar.docs.category.yew-router.link.generated-index.title": {
+    "message": "yew-router",
+    "description": "The generated-index page title for category yew-router in sidebar docs"
   }
 }

website/i18n/ja/docusaurus-plugin-content-docs/version-0.19.0.json

@@ -54,5 +54,21 @@
   "sidebar.sidebar.category.yew-router": {
     "message": "yew-router",
     "description": "The label for category yew-router in sidebar sidebar"
+  },
+  "sidebar.sidebar.category.Migration guides.link.generated-index.title": {
+    "message": "Migration guides",
+    "description": "The generated-index page title for category Migration guides in sidebar sidebar"
+  },
+  "sidebar.sidebar.category.yew.link.generated-index.title": {
+    "message": "yew",
+    "description": "The generated-index page title for category yew in sidebar sidebar"
+  },
+  "sidebar.sidebar.category.yew-agent.link.generated-index.title": {
+    "message": "yew-agent",
+    "description": "The generated-index page title for category yew-agent in sidebar sidebar"
+  },
+  "sidebar.sidebar.category.yew-router.link.generated-index.title": {
+    "message": "yew-router",
+    "description": "The generated-index page title for category yew-router in sidebar sidebar"
   }
 }

website/i18n/ja/docusaurus-plugin-content-docs/version-0.20.json

@@ -82,5 +82,21 @@
   "sidebar.docs.category.yew-router": {
     "message": "yew-router",
     "description": "The label for category yew-router in sidebar docs"
+  },
+  "sidebar.docs.category.Migration guides.link.generated-index.title": {
+    "message": "Migration guides",
+    "description": "The generated-index page title for category Migration guides in sidebar docs"
+  },
+  "sidebar.docs.category.yew.link.generated-index.title": {
+    "message": "yew",
+    "description": "The generated-index page title for category yew in sidebar docs"
+  },
+  "sidebar.docs.category.yew-agent.link.generated-index.title": {
+    "message": "yew-agent",
+    "description": "The generated-index page title for category yew-agent in sidebar docs"
+  },
+  "sidebar.docs.category.yew-router.link.generated-index.title": {
+    "message": "yew-router",
+    "description": "The generated-index page title for category yew-router in sidebar docs"
   }
 }

website/i18n/ja/docusaurus-plugin-content-docs/version-0.21.json

@@ -82,5 +82,21 @@
   "sidebar.docs.category.yew-router": {
     "message": "yew-router",
     "description": "The label for category yew-router in sidebar docs"
+  },
+  "sidebar.docs.category.Migration guides.link.generated-index.title": {
+    "message": "Migration guides",
+    "description": "The generated-index page title for category Migration guides in sidebar docs"
+  },
+  "sidebar.docs.category.yew.link.generated-index.title": {
+    "message": "yew",
+    "description": "The generated-index page title for category yew in sidebar docs"
+  },
+  "sidebar.docs.category.yew-agent.link.generated-index.title": {
+    "message": "yew-agent",
+    "description": "The generated-index page title for category yew-agent in sidebar docs"
+  },
+  "sidebar.docs.category.yew-router.link.generated-index.title": {
+    "message": "yew-router",
+    "description": "The generated-index page title for category yew-router in sidebar docs"
   }
 }

website/i18n/zh-Hans/docusaurus-plugin-content-docs/current.json

@@ -82,5 +82,21 @@
   "sidebar.docs.category.Struct Components": {
     "message": "Struct Components",
     "description": "The label for category Struct Components in sidebar docs"
+  },
+  "sidebar.docs.category.Migration guides.link.generated-index.title": {
+    "message": "Migration guides",
+    "description": "The generated-index page title for category Migration guides in sidebar docs"
+  },
+  "sidebar.docs.category.yew.link.generated-index.title": {
+    "message": "yew",
+    "description": "The generated-index page title for category yew in sidebar docs"
+  },
+  "sidebar.docs.category.yew-agent.link.generated-index.title": {
+    "message": "yew-agent",
+    "description": "The generated-index page title for category yew-agent in sidebar docs"
+  },
+  "sidebar.docs.category.yew-router.link.generated-index.title": {
+    "message": "yew-router",
+    "description": "The generated-index page title for category yew-router in sidebar docs"
   }
 }

website/i18n/zh-Hans/docusaurus-plugin-content-docs/version-0.19.0.json

@@ -54,5 +54,21 @@
   "sidebar.sidebar.category.yew-router": {
     "message": "yew-router",
     "description": "The label for category yew-router in sidebar sidebar"
+  },
+  "sidebar.sidebar.category.Migration guides.link.generated-index.title": {
+    "message": "Migration guides",
+    "description": "The generated-index page title for category Migration guides in sidebar sidebar"
+  },
+  "sidebar.sidebar.category.yew.link.generated-index.title": {
+    "message": "yew",
+    "description": "The generated-index page title for category yew in sidebar sidebar"
+  },
+  "sidebar.sidebar.category.yew-agent.link.generated-index.title": {
+    "message": "yew-agent",
+    "description": "The generated-index page title for category yew-agent in sidebar sidebar"
+  },
+  "sidebar.sidebar.category.yew-router.link.generated-index.title": {
+    "message": "yew-router",
+    "description": "The generated-index page title for category yew-router in sidebar sidebar"
   }
 }

website/i18n/zh-Hans/docusaurus-plugin-content-docs/version-0.20.json

@@ -82,5 +82,21 @@
   "sidebar.docs.category.yew-router": {
     "message": "yew-router",
     "description": "The label for category yew-router in sidebar docs"
+  },
+  "sidebar.docs.category.Migration guides.link.generated-index.title": {
+    "message": "Migration guides",
+    "description": "The generated-index page title for category Migration guides in sidebar docs"
+  },
+  "sidebar.docs.category.yew.link.generated-index.title": {
+    "message": "yew",
+    "description": "The generated-index page title for category yew in sidebar docs"
+  },
+  "sidebar.docs.category.yew-agent.link.generated-index.title": {
+    "message": "yew-agent",
+    "description": "The generated-index page title for category yew-agent in sidebar docs"
+  },
+  "sidebar.docs.category.yew-router.link.generated-index.title": {
+    "message": "yew-router",
+    "description": "The generated-index page title for category yew-router in sidebar docs"
   }
 }

website/i18n/zh-Hans/docusaurus-plugin-content-docs/version-0.21.json

@@ -82,5 +82,21 @@
   "sidebar.docs.category.yew-router": {
     "message": "yew-router",
     "description": "The label for category yew-router in sidebar docs"
+  },
+  "sidebar.docs.category.Migration guides.link.generated-index.title": {
+    "message": "Migration guides",
+    "description": "The generated-index page title for category Migration guides in sidebar docs"
+  },
+  "sidebar.docs.category.yew.link.generated-index.title": {
+    "message": "yew",
+    "description": "The generated-index page title for category yew in sidebar docs"
+  },
+  "sidebar.docs.category.yew-agent.link.generated-index.title": {
+    "message": "yew-agent",
+    "description": "The generated-index page title for category yew-agent in sidebar docs"
+  },
+  "sidebar.docs.category.yew-router.link.generated-index.title": {
+    "message": "yew-router",
+    "description": "The generated-index page title for category yew-router in sidebar docs"
   }
 }

website/i18n/zh-Hant/docusaurus-plugin-content-docs/current.json

@@ -82,5 +82,21 @@
   "sidebar.docs.category.Struct Components": {
     "message": "Struct Components",
     "description": "The label for category Struct Components in sidebar docs"
+  },
+  "sidebar.docs.category.Migration guides.link.generated-index.title": {
+    "message": "Migration guides",
+    "description": "The generated-index page title for category Migration guides in sidebar docs"
+  },
+  "sidebar.docs.category.yew.link.generated-index.title": {
+    "message": "yew",
+    "description": "The generated-index page title for category yew in sidebar docs"
+  },
+  "sidebar.docs.category.yew-agent.link.generated-index.title": {
+    "message": "yew-agent",
+    "description": "The generated-index page title for category yew-agent in sidebar docs"
+  },
+  "sidebar.docs.category.yew-router.link.generated-index.title": {
+    "message": "yew-router",
+    "description": "The generated-index page title for category yew-router in sidebar docs"
   }
 }

website/i18n/zh-Hant/docusaurus-plugin-content-docs/version-0.19.0.json

@@ -54,5 +54,21 @@
   "sidebar.sidebar.category.yew-router": {
     "message": "yew-router",
     "description": "The label for category yew-router in sidebar sidebar"
+  },
+  "sidebar.sidebar.category.Migration guides.link.generated-index.title": {
+    "message": "Migration guides",
+    "description": "The generated-index page title for category Migration guides in sidebar sidebar"
+  },
+  "sidebar.sidebar.category.yew.link.generated-index.title": {
+    "message": "yew",
+    "description": "The generated-index page title for category yew in sidebar sidebar"
+  },
+  "sidebar.sidebar.category.yew-agent.link.generated-index.title": {
+    "message": "yew-agent",
+    "description": "The generated-index page title for category yew-agent in sidebar sidebar"
+  },
+  "sidebar.sidebar.category.yew-router.link.generated-index.title": {
+    "message": "yew-router",
+    "description": "The generated-index page title for category yew-router in sidebar sidebar"
   }
 }

website/i18n/zh-Hant/docusaurus-plugin-content-docs/version-0.20.json

@@ -82,5 +82,21 @@
   "sidebar.docs.category.yew-router": {
     "message": "yew-router",
     "description": "The label for category yew-router in sidebar docs"
+  },
+  "sidebar.docs.category.Migration guides.link.generated-index.title": {
+    "message": "Migration guides",
+    "description": "The generated-index page title for category Migration guides in sidebar docs"
+  },
+  "sidebar.docs.category.yew.link.generated-index.title": {
+    "message": "yew",
+    "description": "The generated-index page title for category yew in sidebar docs"
+  },
+  "sidebar.docs.category.yew-agent.link.generated-index.title": {
+    "message": "yew-agent",
+    "description": "The generated-index page title for category yew-agent in sidebar docs"
+  },
+  "sidebar.docs.category.yew-router.link.generated-index.title": {
+    "message": "yew-router",
+    "description": "The generated-index page title for category yew-router in sidebar docs"
   }
 }

website/i18n/zh-Hant/docusaurus-plugin-content-docs/version-0.21.json

@@ -82,5 +82,21 @@
   "sidebar.docs.category.yew-router": {
     "message": "yew-router",
     "description": "The label for category yew-router in sidebar docs"
+  },
+  "sidebar.docs.category.Migration guides.link.generated-index.title": {
+    "message": "Migration guides",
+    "description": "The generated-index page title for category Migration guides in sidebar docs"
+  },
+  "sidebar.docs.category.yew.link.generated-index.title": {
+    "message": "yew",
+    "description": "The generated-index page title for category yew in sidebar docs"
+  },
+  "sidebar.docs.category.yew-agent.link.generated-index.title": {
+    "message": "yew-agent",
+    "description": "The generated-index page title for category yew-agent in sidebar docs"
+  },
+  "sidebar.docs.category.yew-router.link.generated-index.title": {
+    "message": "yew-router",
+    "description": "The generated-index page title for category yew-router in sidebar docs"
   }
 }

website/sidebars/docs.js

@@ -149,10 +149,18 @@ module.exports = {
         {
             type: 'category',
             label: 'Migration guides',
+            link: {
+                type: 'generated-index',
+                title: 'Migration guides',
+            },
             items: [
                 {
                     type: 'category',
                     label: 'yew',
+                    link: {
+                        type: 'generated-index',
+                        title: 'yew',
+                    },
                     items: [
                         'migration-guides/yew/from-0_20_0-to-0_21_0',
                         'migration-guides/yew/from-0_19_0-to-0_20_0',
@@ -162,6 +170,10 @@ module.exports = {
                 {
                     type: 'category',
                     label: 'yew-agent',
+                    link: {
+                        type: 'generated-index',
+                        title: 'yew-agent',
+                    },
                     items: [
                         'migration-guides/yew-agent/from-0_1_0-to-0_2_0',
                         'migration-guides/yew-agent/from-0_0_0-to-0_1_0',
@@ -170,6 +182,10 @@ module.exports = {
                 {
                     type: 'category',
                     label: 'yew-router',
+                    link: {
+                        type: 'generated-index',
+                        title: 'yew-router',
+                    },
                     items: [
                         'migration-guides/yew-router/from-0_16_0-to-0_17_0',
                         'migration-guides/yew-router/from-0_15_0-to-0_16_0',