From 745b96f1f9f856e5f6aab262b0b47072798091d8 Mon Sep 17 00:00:00 2001 From: Call Delegation <106365423+calldelegation@users.noreply.github.com> Date: Wed, 16 Oct 2024 06:58:06 -0400 Subject: [PATCH] docs: Add verified assets (#453) * ready for review * fix * ready for review * update submodules --- .gitmodules | 6 ++++++ .vscode/settings.json | 3 ++- contentlayer.config.ts | 4 ++++ docs/nightly/verified-addresses | 1 + docs/verified-addresses | 1 + scripts/clean-build-files.mjs | 3 +++ scripts/generate-links/getDocs.mjs | 18 ++++++++++++++++++ scripts/generate-links/getOrders.mjs | 4 ++++ scripts/generate-links/index.mjs | 4 ++++ src/components/SidebarSection.tsx | 3 +++ src/config/docs.json | 9 +++++++++ src/lib/md-doc.ts | 1 + 12 files changed, 56 insertions(+), 1 deletion(-) create mode 160000 docs/nightly/verified-addresses create mode 160000 docs/verified-addresses diff --git a/.gitmodules b/.gitmodules index 7c92ea26d..e811cf132 100644 --- a/.gitmodules +++ b/.gitmodules @@ -90,6 +90,12 @@ [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 diff --git a/.vscode/settings.json b/.vscode/settings.json index b6177b6b0..ec5f2c5ac 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -24,7 +24,8 @@ "**/guides/examples": true, "**/sway-by-example-lib": true, "**/migrations-and-disclosures": true, - "**/fuel-book": true + "**/fuel-book": true, + "**/verified-addresses": true }, "git.ignoreLimitWarning": true, "[typescriptreact]": { diff --git a/contentlayer.config.ts b/contentlayer.config.ts index c22dfc06c..bcb4a8498 100644 --- a/contentlayer.config.ts +++ b/contentlayer.config.ts @@ -66,6 +66,7 @@ const includeDirs = [ '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', @@ -79,6 +80,7 @@ const includeDirs = [ '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', ]; @@ -96,6 +98,7 @@ const excludeDirs = [ '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', @@ -106,6 +109,7 @@ const excludeDirs = [ '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/nightly/verified-addresses b/docs/nightly/verified-addresses new file mode 160000 index 000000000..32d038d5e --- /dev/null +++ b/docs/nightly/verified-addresses @@ -0,0 +1 @@ +Subproject commit 32d038d5e655d08668998c56d51d39b65bfa23a6 diff --git a/docs/verified-addresses b/docs/verified-addresses new file mode 160000 index 000000000..32d038d5e --- /dev/null +++ b/docs/verified-addresses @@ -0,0 +1 @@ +Subproject commit 32d038d5e655d08668998c56d51d39b65bfa23a6 diff --git a/scripts/clean-build-files.mjs b/scripts/clean-build-files.mjs index 4a957db62..909bc64e2 100644 --- a/scripts/clean-build-files.mjs +++ b/scripts/clean-build-files.mjs @@ -26,6 +26,8 @@ const targetDirs = [ './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', ]; @@ -74,6 +76,7 @@ const exclusions = { ], 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 index 1e2a14fbe..372333093 100644 --- a/scripts/generate-links/getDocs.mjs +++ b/scripts/generate-links/getDocs.mjs @@ -100,6 +100,15 @@ 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 @@ -109,6 +118,15 @@ export async function getDocs(key, order) { '!**/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 diff --git a/scripts/generate-links/getOrders.mjs b/scripts/generate-links/getOrders.mjs index 90635ed9d..b9fa5741a 100644 --- 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', }, + '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 index 006d22ac5..edd567cfa 100644 --- a/scripts/generate-links/index.mjs +++ b/scripts/generate-links/index.mjs @@ -103,6 +103,9 @@ function getSidebarName(key) { case 'fuel-book': newKey = 'Fuel Book'; break; + case 'verified-addresses': + newKey = 'Verified Addresses'; + break; case 'guides': newKey = 'Guides'; break; @@ -120,6 +123,7 @@ function handleAllOrders(allOrders, folderPath, filename) { 'migrations-and-disclosures', 'intro', 'fuel-book', + 'verified-addresses', 'guides', 'sway', 'sway-libs', diff --git a/src/components/SidebarSection.tsx b/src/components/SidebarSection.tsx index d1c6a8fd6..57feeec5a 100644 --- a/src/components/SidebarSection.tsx +++ b/src/components/SidebarSection.tsx @@ -61,6 +61,9 @@ export function SidebarSection({ 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 index 88914473e..3b9ad31d6 100644 --- a/src/config/docs.json +++ b/src/config/docs.json @@ -44,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", diff --git a/src/lib/md-doc.ts b/src/lib/md-doc.ts index 634e744c1..24709f8dd 100644 --- a/src/lib/md-doc.ts +++ b/src/lib/md-doc.ts @@ -72,6 +72,7 @@ export class Doc { .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/', '')}`;