feat: Add Fuel Book (#457)

* preview * fixed images and order * updates * bump images * docs: Add verified assets (#453) * ready for review * fix * ready for review * update submodules
FuelLabs · Oct 16, 2024 · dc4500d · dc4500d
1 parent 22d0516
commit dc4500d
Show file tree

Hide file tree

Showing 14 changed files with 112 additions and 2 deletions.
diff --git a/.gitmodules b/.gitmodules
@@ -90,3 +90,15 @@
 [submodule "docs/nightly/integration-docs"]
 	path = docs/nightly/integration-docs
 	url = https://github.com/FuelLabs/integration-docs
+[submodule "docs/verified-addresses"]
+	path = docs/verified-addresses
+	url = https://github.com/FuelLabs/verified-addresses
+[submodule "docs/nightly/verified-addresses"]
+	path = docs/nightly/verified-addresses
+	url = https://github.com/FuelLabs/verified-addresses
+[submodule "docs/fuel-book"]
+	path = docs/fuel-book
+	url = https://github.com/FuelLabs/fuel-book
+[submodule "docs/nightly/fuel-book"]
+	path = docs/nightly/fuel-book
+	url = https://github.com/FuelLabs/fuel-book
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -23,7 +23,9 @@
     "**/fuelup": true,
     "**/guides/examples": true,
     "**/sway-by-example-lib": true,
-    "**/migrations-and-disclosures": true
+    "**/migrations-and-disclosures": true,
+    "**/fuel-book": true,
+    "**/verified-addresses": true
   },
   "git.ignoreLimitWarning": true,
   "[typescriptreact]": {

diff --git a/contentlayer.config.ts b/contentlayer.config.ts
@@ -65,6 +65,8 @@ const includeDirs = [
   'docs/sway-standards/docs/src',
   'docs/sway-by-example-lib/docs/src',
   'docs/migrations-and-disclosures/docs/src',
+  'docs/fuel-book/docs/src',
+  'docs/verified-addresses/docs/src',
   'docs/integration-docs/docs/src',
   // NIGHTLY DOCS
   'docs/nightly/sway/docs/book/src',
@@ -77,6 +79,8 @@ const includeDirs = [
   'docs/nightly/sway-standards/docs/src',
   'docs/nightly/sway-by-example-lib/docs/src',
   'docs/nightly/migrations-and-disclosures/docs/src',
+  'docs/nightly/fuel-book/docs/src',
+  'docs/nightly/verified-addresses/docs/src',
   'docs/nightly/integration-docs/docs/src',
 ];
 
@@ -93,6 +97,8 @@ const excludeDirs = [
   'docs/sway-standards/docs/src/SUMMARY.md',
   'docs/sway-by-example-lib/docs/src/SUMMARY.md',
   'docs/migrations-and-disclosures/docs/src/SUMMARY.md',
+  'docs/fuel-book/docs/src/SUMMARY.md',
+  'docs/verified-addresses/docs/src/SUMMARY.md',
   'docs/integration-docs/docs/src/SUMMARY.md',
   // NIGHTLY DOCS
   'docs/nightly/sway/docs/book/src/SUMMARY.md',
@@ -102,6 +108,8 @@ const excludeDirs = [
   'docs/nightly/sway-standards/docs/src/SUMMARY.md',
   'docs/nightly/sway-by-example-lib/docs/src/SUMMARY.md',
   '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/integration-docs/docs/src/SUMMARY.md',
 ];
 

diff --git a/docs/fuel-book b/docs/fuel-book
diff --git a/docs/nightly/fuel-book b/docs/nightly/fuel-book
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
@@ -24,6 +24,10 @@ const targetDirs = [
   './docs/nightly/sway-by-example-lib',
   './docs/migrations-and-disclosures',
   './docs/nightly/migrations-and-disclosures',
+  './docs/fuel-book',
+  './docs/nightly/fuel-book',
+  './docs/verified-addresses',
+  './docs/nightly/verified-addresses',
   './docs/integration-docs',
   './docs/nightly/integration-docs',
 ];
@@ -71,6 +75,8 @@ const exclusions = {
     'fuel-graphql-docs/src',
   ],
   migrations_and_disclosures: ['migrations-and-disclosures/docs'],
+  fuel_book: ['fuel-book/docs'],
+  verified_addresses: ['verified-addresses/docs'],
   integration_docs: ['integration-docs/docs'],
 };
 

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

diff --git a/scripts/generate-links/getOrders.mjs b/scripts/generate-links/getOrders.mjs
@@ -9,10 +9,18 @@ const CONFIG = {
     type: 'mdbook',
     path: './migrations-and-disclosures/docs/src/SUMMARY.md',
   },
+  'fuel-book': {
+    type: 'mdbook',
+    path: './fuel-book/docs/src/SUMMARY.md',
+  },
   'integration-docs': {
     type: 'mdbook',
     path: './integration-docs/docs/src/SUMMARY.md',
   },
+  'verified-addresses': {
+    type: 'mdbook',
+    path: './verified-addresses/docs/src/SUMMARY.md',
+  },
   sway: {
     type: 'mdbook',
     path: './sway/docs/book/src/SUMMARY.md',

diff --git a/scripts/generate-links/index.mjs b/scripts/generate-links/index.mjs
@@ -100,6 +100,12 @@ function getSidebarName(key) {
     case 'migrations-and-disclosures':
       newKey = 'Migrations & Disclosures';
       break;
+    case 'fuel-book':
+      newKey = 'Fuel Book';
+      break;
+    case 'verified-addresses':
+      newKey = 'Verified Addresses';
+      break;
     case 'guides':
       newKey = 'Guides';
       break;
@@ -116,6 +122,8 @@ function handleAllOrders(allOrders, folderPath, filename) {
   const correctOrder = [
     'migrations-and-disclosures',
     'intro',
+    'fuel-book',
+    'verified-addresses',
     'guides',
     'sway',
     'sway-libs',

diff --git a/src/components/SidebarSection.tsx b/src/components/SidebarSection.tsx
@@ -58,6 +58,12 @@ export function SidebarSection({
       case 'Migrations-and-disclosures':
         githubLink = 'https://github.com/FuelLabs/migrations-and-disclosures';
         break;
+      case 'Fuel-book':
+        githubLink = 'https://github.com/FuelLabs/fuel-book';
+        break;
+      case 'Verified-addresses':
+        githubLink = 'https://github.com/FuelLabs/verified-addresses';
+        break;
       case 'Guides':
         githubLink = 'https://github.com/FuelLabs/docs-hub';
         break;

diff --git a/src/config/docs.json b/src/config/docs.json
@@ -8,6 +8,15 @@
       "image": ""
     }
   },
+  "fuel-book": {
+    "title": "Fuel Book",
+    "slug": "fuel-book",
+    "repository": "https://github.com/FuelLabs/fuel-book",
+    "ogTags": {
+      "description": "Fuel Book",
+      "image": ""
+    }
+  },
   "integration-docs": {
     "title": "Integrations",
     "slug": "integration-docs",
@@ -35,6 +44,15 @@
       "image": ""
     }
   },
+  "verified-addresses": {
+    "title": "Verified Addresses",
+    "slug": "verified-addresses",
+    "repository": "https://github.com/FuelLabs/verified-addresses",
+    "ogTags": {
+      "description": "Verified asset and contract addresses",
+      "image": ""
+    }
+  },
   "guides": {
     "title": "Guides",
     "slug": "guides",
@@ -143,4 +161,4 @@
       "image": ""
     }
   }
-}
+}
diff --git a/src/lib/md-doc.ts b/src/lib/md-doc.ts
@@ -71,6 +71,8 @@ export class Doc {
       .replace('docs/sway/', '')
       .replace('docs/sway-standards/', '')
       .replace('docs/sway-by-example-lib/', '')
+      .replace('docs/fuel-book/', '')
+      .replace('docs/verified-addresses/', '')
       .replace('docs/guides/', '')
       .replace('docs/fuel-specs/', '')}`;