docs: add sway standards (#296)

sarahschwartz · web-flow · commit 52f428209f8f · 2024-06-06T10:01:20.000-06:00
diff --git a/.gitmodules b/.gitmodules
@@ -64,6 +64,12 @@
 [submodule "docs/nightly/sway-libs"]
 	path = docs/nightly/sway-libs
 	url = https://github.com/FuelLabs/sway-libs.git
+[submodule "docs/sway-standards"]
+	path = docs/sway-standards
+	url = https://github.com/FuelLabs/sway-standards
+[submodule "docs/nightly/sway-standards"]
+	path = docs/nightly/sway-standards
+	url = https://github.com/FuelLabs/sway-standards
 [submodule "docs/chain-configuration"]
 	path = docs/chain-configuration
 	url = https://github.com/FuelLabs/chain-configuration
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -10,6 +10,8 @@
     "**/node_modules": true,
     "**/.git": true,
     "**/sway": true,
+    "**/sway-libs": true,
+    "**/sway-standards": true,
     "**/builds": true,
     "**/fuel-graphql-docs": true,
     "**/fuel-indexer": true,
diff --git a/contentlayer.config.ts b/contentlayer.config.ts
@@ -62,6 +62,7 @@ const includeDirs = [
   'docs/intro',
   'docs/contributing',
   'docs/sway-libs/docs/book/src',
+  'docs/sway-standards/docs/src',
   // NIGHTLY DOCS
   'docs/nightly/sway/docs/book/src',
   'docs/nightly/fuels-rs/docs/src',
@@ -70,6 +71,7 @@ const includeDirs = [
   'docs/nightly/fuel-graphql-docs/docs',
   'docs/nightly/fuels-wallet/packages/docs/docs',
   'docs/nightly/sway-libs/docs/book/src',
+  'docs/nightly/sway-standards/docs/src',
 ];
 
 const excludeDirs = [
@@ -86,11 +88,14 @@ const excludeDirs = [
   'docs/fuels-rs/docs/src/SUMMARY.md',
   'docs/fuel-specs/src/SUMMARY.md',
   'docs/sway-libs/docs/book/src/SUMMARY.md',
+  'docs/sway-standards/docs/src/SUMMARY.md',
+  'docs/guides/docs/migration-guide/breaking-change-log/node_modules',
   // NIGHTLY DOCS
   'docs/nightly/sway/docs/book/src/SUMMARY.md',
   'docs/nightly/fuels-rs/docs/src/SUMMARY.md',
   'docs/nightly/fuel-specs/src/SUMMARY.md',
   'docs/nightly/sway-libs/docs/book/src/SUMMARY.md',
+  'docs/nightly/sway-standards/docs/src/SUMMARY.md',
 ];
 
 export default makeSource({
diff --git a/docs/contributing/versions.mdx b/docs/contributing/versions.mdx
@@ -8,10 +8,9 @@ parent:
 
 # Versions
 
-There are three version sets of the docs available in the `docs-hub`: `testnet`(the default version), `beta-5`, and `nightly`.
+There are two version sets of the docs available in the `docs-hub`: `testnet`(the default version), and `nightly`.
 
 - The default version set is compatible with the `latest` toolchain and testnet.
-- The `beta-5` version set is compatible with the `beta-5` toolchain and testnet.
 - The `nightly` version set reflects the latest releases on GitHub. These versions may not be compatible with each other.
 
 ## Updating the Nightly Versions
diff --git a/docs/intro/what-is-fuel.mdx b/docs/intro/what-is-fuel.mdx
@@ -54,10 +54,26 @@ cardsInfo={[
         headingIcon: 'Beach',
         body: 'An introduction to Sway with simple examples',
     },
+    {
+        link: '/docs/sway-libs',
+        nightlyLink: '/docs/nightly/sway-libs',
+        isExternal: false,
+        heading: 'Sway Libraries',
+        headingIcon: 'Book',
+        body: 'Find useful libraries written in Sway.',
+    },
+    {
+        link: '/docs/sway-standards',
+        nightlyLink: '/docs/nightly/sway-standards',
+        isExternal: false,
+        heading: 'Sway Standards',
+        headingIcon: 'Book',
+        body: 'Learn about standards for the Sway language',
+    },
     {
         link: 'https://fuellabs.github.io/sway/master/std/',
         isExternal: true,
-        heading: 'Sway Standard Lib',
+        heading: 'std-lib Reference',
         headingIcon: 'Book',
         body: 'Find definitions for helpful types and methods in Sway.',
     },
@@ -67,7 +83,7 @@ cardsInfo={[
         heading: 'Example Applications',
         headingIcon: 'Apps',
         body: 'Explore end-to-end applications written in Sway.',
-    }
+    },
 ]}
 />
 
diff --git a/docs/nightly/fuels-ts b/docs/nightly/fuels-ts
@@ -1 +1 @@
-Subproject commit 56966f4a487b906e43aec5d032073dd4507f65cb
+Subproject commit ef6c21fb5e7187209889397afec9f1d95da5f042
diff --git a/docs/nightly/sway-libs b/docs/nightly/sway-libs
@@ -1 +1 @@
-Subproject commit 4048cb54e3e68ec8d568419d38b60174d737a3bb
+Subproject commit cc09dae96ea647a5db10b601122606748bb40eeb
diff --git a/docs/nightly/sway-standards b/docs/nightly/sway-standards
@@ -0,0 +1 @@
+Subproject commit 1e567c6442738d9c2f3e9c7a923afceb8770fce4
diff --git a/docs/sway-libs b/docs/sway-libs
@@ -1 +1 @@
-Subproject commit 4048cb54e3e68ec8d568419d38b60174d737a3bb
+Subproject commit cc09dae96ea647a5db10b601122606748bb40eeb
diff --git a/docs/sway-standards b/docs/sway-standards
@@ -0,0 +1 @@
+Subproject commit 1e567c6442738d9c2f3e9c7a923afceb8770fce4
diff --git a/scripts/clean-build-files.mjs b/scripts/clean-build-files.mjs
@@ -15,7 +15,11 @@ const targetDirs = [
   './docs/nightly/fuels-wallet',
   './docs/fuel-graphql-docs',
   './docs/nightly/fuel-graphql-docs',
-  //   './docs/fuel-core',
+  './docs/fuel-core',
+  './docs/sway-libs',
+  './docs/nightly/sway-libs',
+  './docs/sway-standards',
+  './docs/nightly/sway-standards',
 ];
 
 // Exclusions for each type of directory
@@ -30,6 +34,12 @@ const exclusions = {
     'sway/test/src/sdk-harness/test_projects/run_external_proxy',
     'sway/test/src/sdk-harness/test_projects/run_external_target',
   ],
+  sway_libs: ['sway-libs/docs', 'sway-libs/examples', 'sway-libs/Cargo.toml'],
+  sway_standards: [
+    'sway-standards/docs',
+    'sway-standards/examples',
+    'sway-standards/Cargo.toml',
+  ],
   fuels_rs: [
     'fuels-rs/Cargo.toml',
     'fuels-rs/docs',
@@ -44,7 +54,7 @@ const exclusions = {
     'fuels-ts/demo-wallet-sdk-react',
   ],
   fuels_wallet: ['fuels-wallet/package.json', 'fuels-wallet/packages'],
-  //   fuel_core: ['fuel-core/deployment/scripts/chainspec', 'fuel-core/Cargo.toml'],
+  fuel_core: ['fuel-core/deployment', 'fuel-core/bin', 'fuel-core/Cargo.toml'],
   fuel_graphql_docs: [
     'fuel-graphql-docs/docs',
     'fuel-graphql-docs/examples',
diff --git a/scripts/generate-links/getDocs.mjs b/scripts/generate-links/getDocs.mjs
@@ -46,10 +46,20 @@ export async function getDocs(key, order) {
         '!**/SUMMARY.md',
       ];
       break;
-    case 'beta-5-sway-libs':
+    case 'sway-standards':
       paths = [
-        // SWAY DOCS
-        './beta-5/sway-libs/docs/book/src/**/*.md',
+        // SWAY STANDARDS DOCS
+        './sway-standards/docs/src/*.md',
+        './sway-standards/docs/src/**/*.md',
+        // IGNORE ALL SUMMARY PAGES
+        '!**/SUMMARY.md',
+      ];
+      break;
+    case 'nightly-sway-standards':
+      paths = [
+        // SWAY STANDARDS DOCS
+        './nightly/sway-standards/docs/src/*.md',
+        './nightly/sway-standards/docs/src/**/*.md',
         // IGNORE ALL SUMMARY PAGES
         '!**/SUMMARY.md',
       ];
diff --git a/scripts/generate-links/getOrders.mjs b/scripts/generate-links/getOrders.mjs
@@ -13,6 +13,10 @@ const CONFIG = {
     type: 'mdbook',
     path: './sway-libs/docs/book/src/SUMMARY.md',
   },
+  'sway-standards': {
+    type: 'mdbook',
+    path: './sway-standards/docs/src/SUMMARY.md',
+  },
   'fuels-rs': {
     type: 'mdbook',
     path: './fuels-rs/docs/src/SUMMARY.md',
diff --git a/scripts/generate-links/getSortedLinks.mjs b/scripts/generate-links/getSortedLinks.mjs
@@ -183,7 +183,10 @@ function sortLinks(lcOrder, links, config, isNightly) {
         })
     : links;
 
-  return sortedLinks;
+  return sortedLinks.map((link) => {
+    link.label = handleStandards(link.label);
+    return link;
+  });
 }
 
 function getCategory(category) {
@@ -361,3 +364,12 @@ function getSubmenuSubpath(splitSlug) {
 
   return subpath;
 }
+
+function handleStandards(input) {
+  const regex = /^src (\d{1,3}) (.+)$/i;
+  const match = input.match(regex);
+  if (match) {
+    return `SRC-${match[1]}: ${match[2]}`;
+  }
+  return input;
+}
diff --git a/scripts/generate-links/index.mjs b/scripts/generate-links/index.mjs
@@ -97,6 +97,9 @@ function getSidebarName(key) {
     case 'sway-libs':
       newKey = 'Sway Libraries';
       break;
+    case 'sway-standards':
+      newKey = 'Sway Standards';
+      break;
     default:
   }
 
@@ -108,6 +111,7 @@ function handleAllOrders(allOrders, folderPath, filename) {
     'intro',
     'sway',
     'sway-libs',
+    'sway-standards',
     'fuels-ts',
     'fuels-rs',
     'wallet',
diff --git a/scripts/update-nightly/versions.mjs b/scripts/update-nightly/versions.mjs
@@ -8,12 +8,17 @@ export function getExistingVersions() {
     rust: getRustSDKVersion(false),
     ts: getTSSDKVersion(false),
     wallet: getWalletVersion(false),
+    // TODO: uncomment when sway-libs is bumped to 0.22.0
+    // sway_libs: getSwayLibsVersion(false),
+    sway_standards: getSwayStandardsVersion(false),
   };
   versions.nightly = {
     forc: getForcVersion(true),
     rust: getRustSDKVersion(true),
     ts: getTSSDKVersion(true),
     wallet: getWalletVersion(true),
+    // sway_libs: getSwayLibsVersion(true),
+    sway_standards: getSwayStandardsVersion(true),
   };
 
   return versions;
@@ -25,6 +30,8 @@ export async function getNightlyVersions() {
   versions.rust = await getNightlyRelease('fuels-rs');
   versions.ts = await getNightlyRelease('fuels-ts');
   versions.wallet = await getNightlyRelease('fuels-wallet');
+  versions.sway_libs = await getNightlyRelease('sway-libs');
+  versions.sway_standards = await getNightlyRelease('sway-standards');
   return versions;
 }
 
@@ -55,6 +62,18 @@ function getWalletVersion(isNightly) {
   );
 }
 
+function getSwayLibsVersion(isNightly) {
+  return getVersionFromTOMLFile(
+    `docs${isNightly ? '/nightly' : ''}/sway-libs/Cargo.toml`
+  );
+}
+
+function getSwayStandardsVersion(isNightly) {
+  return getVersionFromTOMLFile(
+    `docs${isNightly ? '/nightly' : ''}/sway-standards/Cargo.toml`
+  );
+}
+
 function getVersionFromJSONFile(path) {
   const file = fs.readFileSync(path, 'utf-8');
   const json = JSON.parse(file);
diff --git a/scripts/wallet-patch-fixes/download-link.mjs b/scripts/wallet-patch-fixes/download-link.mjs
@@ -2,6 +2,12 @@ import { readFileSync, writeFileSync } from 'fs';
 import { EOL } from 'os';
 import { join } from 'path';
 
+const versionFile = readFileSync(
+  join(process.cwd(), 'src/config/versions.json'),
+  'utf-8'
+);
+const versions = JSON.parse(versionFile);
+
 const constantsPath = join(
   process.cwd(),
   'docs/fuels-wallet/packages/docs/src/constants.ts'
@@ -31,8 +37,8 @@ function handleConstantsFile(filePath, version) {
   }
 
   if (start !== undefined && end !== undefined) {
-    const downloadLink =
-      'https://github.com/FuelLabs/fuels-wallet/releases/download/v0.21.0/fuel-wallet-0.21.0.zip';
+    const walletVersion = versions.default.wallet;
+    const downloadLink = `https://github.com/FuelLabs/fuels-wallet/releases/download/v${walletVersion}/fuel-wallet-${walletVersion}.zip`;
     const modifiedContent = `export const DOWNLOAD_LINK = '${downloadLink}';`;
     lines.splice(start, end - start + 1, modifiedContent);
     const newFileContent = lines.join(EOL);
diff --git a/src/components/SidebarSection.tsx b/src/components/SidebarSection.tsx
@@ -49,6 +49,9 @@ export function SidebarSection({
       case 'Sway-libs':
         githubLink = 'https://github.com/FuelLabs/sway-libs';
         break;
+      case 'Sway-standards':
+        githubLink = 'https://github.com/FuelLabs/sway-standards';
+        break;
       default:
         break;
     }
diff --git a/src/config/docs.json b/src/config/docs.json
@@ -44,6 +44,15 @@
       "image": ""
     }
   },
+  "sway-standards": {
+    "title": "Sway Standards",
+    "slug": "sway-standards",
+    "repository": "https://github.com/FuelLabs/sway-standards",
+    "ogTags": {
+      "description": "Official documentation for Sway Standards",
+      "image": ""
+    }
+  },
   "fuels-rs": {
     "title": "Fuel Rust SDK",
     "slug": "fuels-rs",
diff --git a/src/config/paths.json b/src/config/paths.json
@@ -4,7 +4,7 @@
   "/book/": "/",
   "/packages/": "/",
   "/apps/": "/",
-  "/src": "",
+  "/src/": "/",
   "/index.md": ".md",
   "/README.md": ".md",
   "/guide/": "/",
diff --git a/src/config/versions.json b/src/config/versions.json
@@ -3,6 +3,8 @@
     "forc": "0.60.0",
     "rust": "0.63.0",
     "ts": "0.89.1",
-    "wallet": "0.21.0"
+    "wallet": "0.21.0",
+    "sway_libs": "0.21.0",
+    "sway_standards": "0.5.0"
   }
 }
diff --git a/src/lib/md-doc.ts b/src/lib/md-doc.ts
@@ -69,6 +69,7 @@ export class Doc {
       .replace('docs/fuels-wallet/', '')
       .replace('docs/fuel-graphql-docs/', '')
       .replace('docs/sway/', '')
+      .replace('docs/sway-standards/', '')
       .replace('docs/fuel-specs/', '')}`;
 
     let pageLink = `${config.repository}${actualPath.replace(
@@ -87,7 +88,8 @@ export class Doc {
         versionSet = 'nightly';
       }
       const version = getDocVersion(pageLink, versionSet);
-      if (version !== 'master') {
+      // TODO: remove the exception for sway-standards once version is bumped past 0.5.0
+      if (version !== 'master' && !pageLink.includes("/FuelLabs/sway-standards")) {
         pageLink = pageLink
           .replace('/tree/master/', `/tree/${version}/`)
           .replace('/blob/master/', `/blob/${version}/`);
diff --git a/src/lib/md-parser.ts b/src/lib/md-parser.ts
@@ -26,6 +26,11 @@ export class DocParser {
       const value = pathsConfig[key];
       slug = slug.replaceAll(key, value as string);
     }
+
+    if(slug.endsWith('/src')){
+      slug = slug.replace('/src', '');
+    }
+
     return slug.toLowerCase();
   }
 }
diff --git a/src/lib/plugins/links.ts b/src/lib/plugins/links.ts
diff --git a/src/lib/versions.ts b/src/lib/versions.ts
diff --git a/tests/utils/fixtures/index.ts b/tests/utils/fixtures/index.ts
