From 330d93e59b76dd98d6db44f3790d0b2ad608ddc1 Mon Sep 17 00:00:00 2001 From: Call Delegation <106365423+calldelegation@users.noreply.github.com> Date: Mon, 7 Oct 2024 00:34:05 -0400 Subject: [PATCH 1/5] preview --- .gitmodules | 6 ++++++ .vscode/settings.json | 3 ++- contentlayer.config.ts | 4 ++++ docs/fuel-book | 1 + docs/nightly/fuel-book | 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 | 11 ++++++++++- src/lib/md-doc.ts | 1 + 12 files changed, 57 insertions(+), 2 deletions(-) create mode 160000 docs/fuel-book create mode 160000 docs/nightly/fuel-book diff --git a/.gitmodules b/.gitmodules index 924736867..7c92ea26d 100644 --- a/.gitmodules +++ b/.gitmodules @@ -90,3 +90,9 @@ [submodule "docs/nightly/integration-docs"] path = docs/nightly/integration-docs url = https://github.com/FuelLabs/integration-docs +[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 index 9de43acef..b6177b6b0 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -23,7 +23,8 @@ "**/fuelup": true, "**/guides/examples": true, "**/sway-by-example-lib": true, - "**/migrations-and-disclosures": true + "**/migrations-and-disclosures": true, + "**/fuel-book": true }, "git.ignoreLimitWarning": true, "[typescriptreact]": { diff --git a/contentlayer.config.ts b/contentlayer.config.ts index e9a621279..c22dfc06c 100644 --- a/contentlayer.config.ts +++ b/contentlayer.config.ts @@ -65,6 +65,7 @@ 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/integration-docs/docs/src', // NIGHTLY DOCS 'docs/nightly/sway/docs/book/src', @@ -77,6 +78,7 @@ 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/integration-docs/docs/src', ]; @@ -93,6 +95,7 @@ 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/integration-docs/docs/src/SUMMARY.md', // NIGHTLY DOCS 'docs/nightly/sway/docs/book/src/SUMMARY.md', @@ -102,6 +105,7 @@ 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/integration-docs/docs/src/SUMMARY.md', ]; diff --git a/docs/fuel-book b/docs/fuel-book new file mode 160000 index 000000000..15f3ef11f --- /dev/null +++ b/docs/fuel-book @@ -0,0 +1 @@ +Subproject commit 15f3ef11fa9de0defdae714fea5a9fa6d8d89ae7 diff --git a/docs/nightly/fuel-book b/docs/nightly/fuel-book new file mode 160000 index 000000000..15f3ef11f --- /dev/null +++ b/docs/nightly/fuel-book @@ -0,0 +1 @@ +Subproject commit 15f3ef11fa9de0defdae714fea5a9fa6d8d89ae7 diff --git a/scripts/clean-build-files.mjs b/scripts/clean-build-files.mjs index cbfe9a4dc..4a957db62 100644 --- a/scripts/clean-build-files.mjs +++ b/scripts/clean-build-files.mjs @@ -24,6 +24,8 @@ 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/integration-docs', './docs/nightly/integration-docs', ]; @@ -71,6 +73,7 @@ const exclusions = { 'fuel-graphql-docs/src', ], migrations_and_disclosures: ['migrations-and-disclosures/docs'], + fuel_book: ['fuel-book/docs'], integration_docs: ['integration-docs/docs'], }; diff --git a/scripts/generate-links/getDocs.mjs b/scripts/generate-links/getDocs.mjs index f9dc47315..1e2a14fbe 100644 --- a/scripts/generate-links/getDocs.mjs +++ b/scripts/generate-links/getDocs.mjs @@ -100,6 +100,24 @@ export async function getDocs(key, order) { '!**/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-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 index 7318dfbb3..90635ed9d 100644 --- a/scripts/generate-links/getOrders.mjs +++ b/scripts/generate-links/getOrders.mjs @@ -9,6 +9,10 @@ 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', diff --git a/scripts/generate-links/index.mjs b/scripts/generate-links/index.mjs index 996818b2a..da7e0c0d2 100644 --- a/scripts/generate-links/index.mjs +++ b/scripts/generate-links/index.mjs @@ -100,6 +100,9 @@ function getSidebarName(key) { case 'migrations-and-disclosures': newKey = 'Migrations & Disclosures'; break; + case 'fuel-book': + newKey = 'Fuel Book'; + break; case 'guides': newKey = 'Guides'; break; @@ -115,6 +118,7 @@ function getSidebarName(key) { function handleAllOrders(allOrders, folderPath, filename) { const correctOrder = [ 'migrations-and-disclosures', + 'fuel-book', 'intro', 'guides', 'sway', diff --git a/src/components/SidebarSection.tsx b/src/components/SidebarSection.tsx index 3d7c472c1..d1c6a8fd6 100644 --- a/src/components/SidebarSection.tsx +++ b/src/components/SidebarSection.tsx @@ -58,6 +58,9 @@ 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 'Guides': githubLink = 'https://github.com/FuelLabs/docs-hub'; break; diff --git a/src/config/docs.json b/src/config/docs.json index 123d7309f..88914473e 100644 --- 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", @@ -143,4 +152,4 @@ "image": "" } } -} +} \ No newline at end of file diff --git a/src/lib/md-doc.ts b/src/lib/md-doc.ts index 7e4bc0bf3..634e744c1 100644 --- a/src/lib/md-doc.ts +++ b/src/lib/md-doc.ts @@ -71,6 +71,7 @@ export class Doc { .replace('docs/sway/', '') .replace('docs/sway-standards/', '') .replace('docs/sway-by-example-lib/', '') + .replace('docs/fuel-book/', '') .replace('docs/guides/', '') .replace('docs/fuel-specs/', '')}`; From c39a32644eaa3dcd3785d2f96d62a0d3c4817e67 Mon Sep 17 00:00:00 2001 From: Call Delegation <106365423+calldelegation@users.noreply.github.com> Date: Mon, 7 Oct 2024 01:35:33 -0400 Subject: [PATCH 2/5] fixed images and order --- docs/fuel-book | 2 +- docs/nightly/fuel-book | 2 +- scripts/generate-links/index.mjs | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/fuel-book b/docs/fuel-book index 15f3ef11f..6499c15a3 160000 --- a/docs/fuel-book +++ b/docs/fuel-book @@ -1 +1 @@ -Subproject commit 15f3ef11fa9de0defdae714fea5a9fa6d8d89ae7 +Subproject commit 6499c15a345dec60eff52baacd3ab9b3c06fd6a0 diff --git a/docs/nightly/fuel-book b/docs/nightly/fuel-book index 15f3ef11f..6499c15a3 160000 --- a/docs/nightly/fuel-book +++ b/docs/nightly/fuel-book @@ -1 +1 @@ -Subproject commit 15f3ef11fa9de0defdae714fea5a9fa6d8d89ae7 +Subproject commit 6499c15a345dec60eff52baacd3ab9b3c06fd6a0 diff --git a/scripts/generate-links/index.mjs b/scripts/generate-links/index.mjs index da7e0c0d2..006d22ac5 100644 --- a/scripts/generate-links/index.mjs +++ b/scripts/generate-links/index.mjs @@ -118,8 +118,8 @@ function getSidebarName(key) { function handleAllOrders(allOrders, folderPath, filename) { const correctOrder = [ 'migrations-and-disclosures', - 'fuel-book', 'intro', + 'fuel-book', 'guides', 'sway', 'sway-libs', From 606694de95be83b200083a950118c844112cd61d Mon Sep 17 00:00:00 2001 From: Call Delegation <106365423+calldelegation@users.noreply.github.com> Date: Mon, 7 Oct 2024 16:58:19 -0400 Subject: [PATCH 3/5] updates --- docs/fuel-book | 2 +- docs/nightly/fuel-book | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/fuel-book b/docs/fuel-book index 6499c15a3..85b95d463 160000 --- a/docs/fuel-book +++ b/docs/fuel-book @@ -1 +1 @@ -Subproject commit 6499c15a345dec60eff52baacd3ab9b3c06fd6a0 +Subproject commit 85b95d463320d38e99960286aad898a771d1965e diff --git a/docs/nightly/fuel-book b/docs/nightly/fuel-book index 6499c15a3..85b95d463 160000 --- a/docs/nightly/fuel-book +++ b/docs/nightly/fuel-book @@ -1 +1 @@ -Subproject commit 6499c15a345dec60eff52baacd3ab9b3c06fd6a0 +Subproject commit 85b95d463320d38e99960286aad898a771d1965e From 09f35eb3a949548817fb064543dc3de5261c7fbe Mon Sep 17 00:00:00 2001 From: Call Delegation <106365423+calldelegation@users.noreply.github.com> Date: Tue, 8 Oct 2024 10:14:09 -0600 Subject: [PATCH 4/5] bump images --- docs/fuel-book | 2 +- docs/nightly/fuel-book | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/fuel-book b/docs/fuel-book index 85b95d463..57d4a4edb 160000 --- a/docs/fuel-book +++ b/docs/fuel-book @@ -1 +1 @@ -Subproject commit 85b95d463320d38e99960286aad898a771d1965e +Subproject commit 57d4a4edba220df4c935563dd4681c45910646dd diff --git a/docs/nightly/fuel-book b/docs/nightly/fuel-book index 85b95d463..57d4a4edb 160000 --- a/docs/nightly/fuel-book +++ b/docs/nightly/fuel-book @@ -1 +1 @@ -Subproject commit 85b95d463320d38e99960286aad898a771d1965e +Subproject commit 57d4a4edba220df4c935563dd4681c45910646dd 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 5/5] 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/', '')}`;