Merge branch 'master' into fix-docs

FuelLabs · Dec 20, 2024 · 4bfe683 · 4bfe683
2 parents 53c2094 + 86506d5
commit 4bfe683
Show file tree

Hide file tree

Showing 14 changed files with 59 additions and 4 deletions.
diff --git a/.gitmodules b/.gitmodules
@@ -103,3 +103,9 @@
 [submodule "docs/nightly/fuel-book"]
 	path = docs/nightly/fuel-book
 	url = https://github.com/FuelLabs/fuel-book
+[submodule "docs/fuel-token-overview"]
+	path = docs/fuel-token-overview
+	url = https://github.com/FuelLabs/fuel-token-overview.git
+[submodule "docs/nightly/fuel-token-overview"]
+	path = docs/nightly/fuel-token-overview
+	url = https://github.com/FuelLabs/fuel-token-overview.git
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -25,7 +25,8 @@
     "**/sway-by-example-lib": true,
     "**/migrations-and-disclosures": true,
     "**/fuel-book": true,
-    "**/verified-addresses": true
+    "**/verified-addresses": true,
+    "**/fuel-token-overview": true
   },
   "git.ignoreLimitWarning": true,
   "[typescriptreact]": {

diff --git a/contentlayer.config.ts b/contentlayer.config.ts
@@ -67,6 +67,7 @@ const includeDirs = [
   'docs/migrations-and-disclosures/docs/src',
   'docs/fuel-book/docs/src',
   'docs/verified-addresses/docs/src',
+  'docs/fuel-token-overview/docs/src',
   'docs/integration-docs/docs/src',
   // NIGHTLY DOCS
   'docs/nightly/sway/docs/book/src',
@@ -81,6 +82,7 @@ const includeDirs = [
   'docs/nightly/migrations-and-disclosures/docs/src',
   'docs/nightly/fuel-book/docs/src',
   'docs/nightly/verified-addresses/docs/src',
+  'docs/nightly/fuel-token-overview/docs/src',
   'docs/nightly/integration-docs/docs/src',
 ];
 
@@ -99,6 +101,7 @@ const excludeDirs = [
   'docs/migrations-and-disclosures/docs/src/SUMMARY.md',
   'docs/fuel-book/docs/src/SUMMARY.md',
   'docs/verified-addresses/docs/src/SUMMARY.md',
+  'docs/fuel-token-overview/docs/src/SUMMARY.md',
   'docs/integration-docs/docs/src/SUMMARY.md',
   // NIGHTLY DOCS
   'docs/nightly/sway/docs/book/src/SUMMARY.md',
@@ -110,6 +113,7 @@ const excludeDirs = [
   'docs/nightly/migrations-and-disclosures/docs/src/SUMMARY.md',
   'docs/nightly/fuel-book/docs/src/SUMMARY.md',
   'docs/nightly/verified-addresses/docs/src/SUMMARY.md',
+  'docs/nightly/fuel-token-overview/docs/src/SUMMARY.md',
   'docs/nightly/integration-docs/docs/src/SUMMARY.md',
 ];
 

diff --git a/docs/fuel-token-overview b/docs/fuel-token-overview
diff --git a/docs/nightly/fuel-token-overview b/docs/nightly/fuel-token-overview
diff --git a/docs/nightly/verified-addresses b/docs/nightly/verified-addresses
diff --git a/docs/verified-addresses b/docs/verified-addresses
diff --git a/scripts/clean-build-files.mjs b/scripts/clean-build-files.mjs
@@ -28,6 +28,8 @@ const targetDirs = [
   './docs/nightly/fuel-book',
   './docs/verified-addresses',
   './docs/nightly/verified-addresses',
+  './docs/fuel-token-overview',
+  './docs/nightly/fuel-token-overview',
   './docs/integration-docs',
   './docs/nightly/integration-docs',
 ];
@@ -77,6 +79,7 @@ const exclusions = {
   migrations_and_disclosures: ['migrations-and-disclosures/docs'],
   fuel_book: ['fuel-book/docs'],
   verified_addresses: ['verified-addresses/docs'],
+  fuel_token_overview: ['fuel-token-overview/docs'],
   integration_docs: ['integration-docs/docs'],
 };
 

diff --git a/scripts/generate-links/getDocs.mjs b/scripts/generate-links/getDocs.mjs
@@ -109,6 +109,15 @@ export async function getDocs(key, order) {
         '!**/SUMMARY.md',
       ];
       break;
+    case 'fuel-token-overview':
+      paths = [
+        // BREAKING CHANGE LOG DOCS
+        './fuel-token-overview/docs/src/*.md',
+        './fuel-token-overview/docs/src/**/*.md',
+        // IGNORE ALL SUMMARY PAGES
+        '!**/SUMMARY.md',
+      ];
+      break;
     case 'fuel-book':
       paths = [
         // BREAKING CHANGE LOG DOCS
@@ -127,6 +136,15 @@ export async function getDocs(key, order) {
         '!**/SUMMARY.md',
       ];
       break;
+    case 'nightly-fuel-token-overview':
+      paths = [
+        // BREAKING CHANGE LOG DOCS
+        './nightly/fuel-token-overview/docs/src/*.md',
+        './nightly/fuel-token-overview/docs/src/**/*.md',
+        // IGNORE ALL SUMMARY PAGES
+        '!**/SUMMARY.md',
+      ];
+      break;
     case 'nightly-fuel-book':
       paths = [
         // BREAKING CHANGE LOG DOCS

diff --git a/scripts/generate-links/getOrders.mjs b/scripts/generate-links/getOrders.mjs
@@ -17,6 +17,10 @@ const CONFIG = {
     type: 'mdbook',
     path: './integration-docs/docs/src/SUMMARY.md',
   },
+  'fuel-token-overview': {
+    type: 'mdbook',
+    path: './fuel-token-overview/docs/src/SUMMARY.md',
+  },
   'verified-addresses': {
     type: 'mdbook',
     path: './verified-addresses/docs/src/SUMMARY.md',

diff --git a/scripts/generate-links/index.mjs b/scripts/generate-links/index.mjs
@@ -106,6 +106,9 @@ function getSidebarName(key) {
     case 'verified-addresses':
       newKey = 'Verified Addresses';
       break;
+    case 'fuel-token-overview':
+      newKey = 'Fuel Token Overview';
+      break;
     case 'guides':
       newKey = 'Guides';
       break;
@@ -123,6 +126,7 @@ function handleAllOrders(allOrders, folderPath, filename) {
     'migrations-and-disclosures',
     'intro',
     'fuel-book',
+    'fuel-token-overview',
     'verified-addresses',
     'guides',
     'sway',

diff --git a/src/components/SidebarSection.tsx b/src/components/SidebarSection.tsx
@@ -64,6 +64,9 @@ export function SidebarSection({
       case 'Verified-addresses':
         githubLink = 'https://github.com/FuelLabs/verified-addresses';
         break;
+      case 'Fuel-token-overview':
+        githubLink = 'https://github.com/FuelLabs/fuel-token-overview';
+        break;
       case 'Guides':
         githubLink = 'https://github.com/FuelLabs/docs-hub';
         break;

diff --git a/src/config/docs.json b/src/config/docs.json
@@ -53,6 +53,15 @@
       "image": ""
     }
   },
+  "fuel-token-overview": {
+    "title": "Fuel Token Overview",
+    "slug": "fuel-token-overview",
+    "repository": "https://github.com/FuelLabs/fuel-token-overview",
+    "ogTags": {
+      "description": "An overview of the Fuel token",
+      "image": ""
+    }
+  },
   "guides": {
     "title": "Guides",
     "slug": "guides",
@@ -161,4 +170,4 @@
       "image": ""
     }
   }
-}
+}
diff --git a/src/lib/md-doc.ts b/src/lib/md-doc.ts
@@ -73,6 +73,7 @@ export class Doc {
       .replace('docs/sway-by-example-lib/', '')
       .replace('docs/fuel-book/', '')
       .replace('docs/verified-addresses/', '')
+      .replace('docs/fuel-token-overview/', '')
       .replace('docs/fuel-specs/', '')}`;
 
     let pageLink = `${config.repository}${actualPath.replace(
+10 −0		docs/spell-check-custom-words.txt
+5 −0		docs/src/assets.md
+1 −1		package.json