docs: Add Sway By Example (#327)

* done

* updating slugs

* fix main merge

* summary ignore

.gitmodules

@@ -73,6 +73,12 @@
 [submodule "docs/chain-configuration"]
 	path = docs/chain-configuration
 	url = https://github.com/FuelLabs/chain-configuration
+[submodule "docs/sway-by-example-lib"]
+	path = docs/sway-by-example-lib
+	url = https://github.com/FuelLabs/sway-by-example-lib.git
+[submodule "docs/nightly/sway-by-example-lib"]
+	path = docs/nightly/sway-by-example-lib
+	url = https://github.com/FuelLabs/sway-by-example-lib.git
 [submodule "docs/breaking-change-log"]
 	path = docs/breaking-change-log
 	url = https://github.com/FuelLabs/breaking-change-log.git

.vscode/settings.json

@@ -22,6 +22,7 @@
     "**/fuels-wallet": true,
     "**/fuelup": true,
     "**/guides/examples": true,
+    "**/sway-by-example-lib": true,
     "**/breaking-change-log": true
   },
   "git.ignoreLimitWarning": true,

contentlayer.config.ts

@@ -63,6 +63,7 @@ const includeDirs = [
   'docs/contributing',
   'docs/sway-libs/docs/book/src',
   'docs/sway-standards/docs/src',
+  'docs/sway-by-example-lib/docs/src',
   'docs/breaking-change-log/docs/src',
   // NIGHTLY DOCS
   'docs/nightly/sway/docs/book/src',
@@ -73,6 +74,7 @@ const includeDirs = [
   'docs/nightly/fuels-wallet/packages/docs/docs',
   'docs/nightly/sway-libs/docs/book/src',
   'docs/nightly/sway-standards/docs/src',
+  'docs/nightly/sway-by-example-lib/docs/src',
   'docs/nightly/breaking-change-log/docs/src',
 ];
 
@@ -91,6 +93,7 @@ const excludeDirs = [
   'docs/fuel-specs/src/SUMMARY.md',
   'docs/sway-libs/docs/book/src/SUMMARY.md',
   'docs/sway-standards/docs/src/SUMMARY.md',
+  'docs/sway-by-example-lib/docs/src/SUMMARY.md',
   'docs/guides/docs/migration-guide/breaking-change-log/node_modules',
   'docs/breaking-change-log/docs/src/SUMMARY.md',
   // NIGHTLY DOCS
@@ -99,6 +102,7 @@ const excludeDirs = [
   'docs/nightly/fuel-specs/src/SUMMARY.md',
   'docs/nightly/sway-libs/docs/book/src/SUMMARY.md',
   'docs/nightly/sway-standards/docs/src/SUMMARY.md',
+  'docs/nightly/sway-by-example-lib/docs/src/SUMMARY.md',
   'docs/nightly/breaking-change-log/docs/src/SUMMARY.md',
 ];
 

scripts/clean-build-files.mjs

@@ -20,6 +20,8 @@ const targetDirs = [
   './docs/nightly/sway-libs',
   './docs/sway-standards',
   './docs/nightly/sway-standards',
+  './docs/sway-by-example-lib',
+  './docs/nightly/sway-by-example-lib',
   './docs/breaking-change-log',
   './docs/nightly/breaking-change-log',
 ];
@@ -42,6 +44,10 @@ const exclusions = {
     'sway-standards/examples',
     'sway-standards/Cargo.toml',
   ],
+  sway_by_example_lib: [
+    'sway-by-example-lib/docs',
+    'sway-by-example-lib/examples',
+  ],
   fuels_rs: [
     'fuels-rs/Cargo.toml',
     'fuels-rs/docs',

scripts/generate-links/getDocs.mjs

@@ -64,6 +64,24 @@ export async function getDocs(key, order) {
         '!**/SUMMARY.md',
       ];
       break;
+    case 'sway-by-example-lib':
+      paths = [
+        // SWAY BY EXAMPLE DOCS
+        './sway-by-example-lib/docs/src/*.md',
+        './sway-by-example-lib/docs/src/**/*.md',
+        // IGNORE ALL SUMMARY PAGES
+        '!**/SUMMARY.md',
+      ];
+      break;
+    case 'nightly-sway-by-example-lib':
+      paths = [
+        // SWAY BY EXAMPLE DOCS
+        './nightly/sway-by-example-lib/docs/src/*.md',
+        './nightly/sway-by-example-lib/docs/src/**/*.md',
+        // IGNORE ALL SUMMARY PAGES
+        '!**/SUMMARY.md',
+      ];
+      break;
     case 'breaking-change-log':
       paths = [
         // BREAKING CHANGE LOG DOCS

scripts/generate-links/getOrders.mjs

@@ -21,6 +21,10 @@ const CONFIG = {
     type: 'mdbook',
     path: './sway-standards/docs/src/SUMMARY.md',
   },
+  'sway-by-example-lib': {
+    type: 'mdbook',
+    path: './sway-by-example-lib/docs/src/SUMMARY.md',
+  },
   'fuels-rs': {
     type: 'mdbook',
     path: './fuels-rs/docs/src/SUMMARY.md',

scripts/generate-links/index.mjs

@@ -100,6 +100,9 @@ function getSidebarName(key) {
     case 'sway-standards':
       newKey = 'Sway Standards';
       break;
+    case 'sway-by-example-lib':
+      newKey = 'Sway By Example';
+      break;
     case 'breaking-change-log':
       newKey = 'Breaking Change Notices';
       break;
@@ -116,6 +119,7 @@ function handleAllOrders(allOrders, folderPath, filename) {
     'sway',
     'sway-libs',
     'sway-standards',
+    'sway-by-example-lib',
     'fuels-ts',
     'fuels-rs',
     'wallet',

src/components/SidebarSection.tsx

@@ -52,9 +52,12 @@ export function SidebarSection({
       case 'Sway-standards':
         githubLink = 'https://github.com/FuelLabs/sway-standards';
         break;
+      case 'Sway-by-example-lib':
+        githubLink = 'https://github.com/FuelLabs/sway-by-example-lib';
+        break;
       case 'Breaking-change-log':
-          githubLink = 'https://github.com/FuelLabs/breaking-change-log';
-          break;
+        githubLink = 'https://github.com/FuelLabs/breaking-change-log';
+        break;
       default:
         break;
     }

src/config/docs.json

@@ -62,6 +62,15 @@
       "image": ""
     }
   },
+  "sway-by-example-lib": {
+    "title": "Sway By Example Lib",
+    "slug": "sway-by-example-lib",
+    "repository": "https://github.com/FuelLabs/sway-by-example-lib",
+    "ogTags": {
+      "description": "An introduction to Sway with simple examples",
+      "image": ""
+    }
+  },
   "fuels-rs": {
     "title": "Fuel Rust SDK",
     "slug": "fuels-rs",

src/lib/md-doc.ts

@@ -70,6 +70,7 @@ export class Doc {
       .replace('docs/fuel-graphql-docs/', '')
       .replace('docs/sway/', '')
       .replace('docs/sway-standards/', '')
+      .replace('docs/sway-by-example-lib/', '')
       .replace('docs/breaking-change-log/', '')
       .replace('docs/fuel-specs/', '')}`;