feat: add breaking change logs (#97)

FuelLabs · Oct 27, 2023 · f996010 · f996010
1 parent 46f5b49
commit f996010
Show file tree

Hide file tree

Showing 14 changed files with 50 additions and 37 deletions.
diff --git a/.gitmodules b/.gitmodules
@@ -58,3 +58,6 @@
 [submodule "docs/latest/fuel-specs"]
 	path = docs/latest/fuel-specs
 	url = https://github.com/FuelLabs/fuel-specs.git
+[submodule "docs/guides/docs/migration-guide/breaking-change-log"]
+	path = docs/guides/docs/migration-guide/breaking-change-log
+	url = https://github.com/FuelLabs/breaking-change-log
diff --git a/contentlayer.config.ts b/contentlayer.config.ts
@@ -95,6 +95,9 @@ const excludeDirs = [
   'docs/latest/fuel-indexer/docs/src/SUMMARY.md',
   'docs/latest/fuel-specs/src/SUMMARY.md',
   // 'docs/fuel-nix/book/src/SUMMARY.md',
+  'docs/guides/docs/migration-guide/breaking-change-log/README.md',
+  'docs/guides/docs/migration-guide/breaking-change-log/package.json',
+  'docs/guides/docs/migration-guide/breaking-change-log/pnpm-lock.yaml',
 ];
 
 export default makeSource({

diff --git a/docs/guides/docs/guides.json b/docs/guides/docs/guides.json
@@ -11,8 +11,8 @@
     "title": "Running a Node",
     "description": "Run a local Fuel node."
   },
-  "testnet_migration": {
-    "title": "Testnet Migration",
+  "migration_guide": {
+    "title": "Migration Guide",
     "description": "Sway and SDK's breaking changes reference."
   }
 }
diff --git a/docs/guides/docs/migration-guide/breaking-change-log b/docs/guides/docs/migration-guide/breaking-change-log
diff --git a/docs/guides/docs/migration-guide/index.mdx b/docs/guides/docs/migration-guide/index.mdx
@@ -0,0 +1,20 @@
+---
+title: Migration Guide
+category: Migration Guide
+parent:
+  label: Guides
+  link: /guides
+---
+
+# Migration Guide
+
+Throughout Fuel's development journey, numerous testnets have been created to ensure a seamless transition to the mainnet launch.
+Given the dynamic nature of learning and adapting during these testing phases, it's common to encounter breaking changes.
+
+## Breaking Changes
+
+Learn how to migrate to the latest versions of the Fuel toolchain and SDKs in the [Breaking Changes Log](/guides/migration-guide/breaking-changes-log).
+
+## Testnet Migration Guide
+
+Upgrade to the latest Fuel testnet using the [Testnet Migration](/guides/migration-guide/testnet-migration) guide.
diff --git a/...-migration/beta-3-to-beta-4-migration.mdx → ...ocs/migration-guide/testnet-migration.mdx b/...-migration/beta-3-to-beta-4-migration.mdx → ...ocs/migration-guide/testnet-migration.mdx
@@ -1,16 +1,14 @@
 ---
-title: Beta 4 Testnet Migration 
-category: Testnet Migration
+title: Testnet Migration 
+category: Migration Guide
 parent:
   label: Guides
   link: /guides
 ---
 
-# Beta 4 Migration
+# Testnet Migration
 
-This guide focuses on the transition from the end of tool support for `beta 3` to the start of `beta 4`.
-
-> The team is constantly building. For updates on breaking changes beyond this guide, please refer to our bi-weekly report on [GitHub](https://github.com/FuelLabs/breaking-change-log/tree/master) or check announcements in our [forum](https://forum.fuel.network/c/announcements/7).
+This guide focuses on the transition from the end of tool support for `beta-3` to the start of `beta-4`.
 
 - [Fuelup v0.19.5](https://github.com/FuelLabs/fuelup/releases/tag/v0.19.5)
 - [Sway v0.45.0](https://github.com/FuelLabs/sway/releases/tag/v0.45.0)

diff --git a/docs/guides/docs/nav.json b/docs/guides/docs/nav.json
@@ -3,5 +3,5 @@
   "installation": ["Fuel Github Codespace"],
   "quickstart": ["Building a Smart Contract", "Building a Frontend"],
   "running_a_node": ["Running a Local Node", "Running a Beta-4 Node"],
-  "testnet_migration": ["Beta 4 Testnet Migration"]
+  "migration_guide": ["Breaking Changes Log", "Testnet Migration"]
 }
diff --git a/docs/guides/docs/testnet-migration/index.mdx b/docs/guides/docs/testnet-migration/index.mdx
diff --git a/next.config.js b/next.config.js
@@ -58,6 +58,16 @@ const nextConfig = {
         destination: '/docs/graphql/overview/',
         permanent: true,
       },
+      {
+        source: '/guides/testnet-migration/',
+        destination: '/guides/migration-guide/',
+        permanent: true,
+      },
+      {
+        source: '/guides/testnet-migration/beta-3-to-beta-4-migration/',
+        destination: '/guides/migration-guide/testnet-migration/',
+        permanent: true,
+      },
     ];
   },
   typescript: {

diff --git a/scripts/generate-links/getDocs.mjs b/scripts/generate-links/getDocs.mjs
@@ -164,6 +164,7 @@ export async function getDocs(key, order) {
       paths = [
         // GUIDES
         './guides/docs/**/*.mdx',
+        './guides/docs/migration-guide/breaking-change-log/breaking-changes-log.md',
       ];
       break;
     // case 'latest-guides':

diff --git a/scripts/update-latest/updateLatest.mjs b/scripts/update-latest/updateLatest.mjs
@@ -52,6 +52,7 @@ async function updateSubmodules(newVersions) {
     'docs/latest/fuel-specs',
     'docs/latest/fuel-graphql-docs',
     'docs/latest/fuelup',
+    'docs/guides/docs/migration-guide/breaking-change-log',
   ];
   console.log('GOING TO UPDATE REGARDLESS');
   await Promise.all(

diff --git a/spell-check-custom-words.txt b/spell-check-custom-words.txt
@@ -1,4 +1,5 @@
 SDK
+SDKs
 testnet
 testnets
 mainnet

diff --git a/src/components/Layout.tsx b/src/components/Layout.tsx
@@ -104,7 +104,7 @@ const styles = {
       maxWidth: '1000px',
       width: '100vw',
       boxSizing: 'border-box',
-      margin: 'auto',
+      mx: 'auto',
     },
 
     '@xl': {

diff --git a/src/config/paths.json b/src/config/paths.json
@@ -16,5 +16,6 @@
   "fuel-graphql-docs": "graphql",
   "fuel-specs": "specs",
   "fuel-indexer": "indexer",
-  "fuels-wallet": "wallet"
+  "fuels-wallet": "wallet",
+  "breaking-change-log/breaking-changes-log": "breaking-changes-log"
 }
-Original file line number
+Diff line change
@@ -1,4 +1,5 @@
     SDK
+    SDKs
     testnet
     testnets
     mainnet
@@ Expand Down @@