From 39f7bf34aa0072dbf26dc80d996cbe3365678a85 Mon Sep 17 00:00:00 2001 From: Call Delegation <106365423+calldelegation@users.noreply.github.com> Date: Thu, 12 Dec 2024 14:13:32 -0500 Subject: [PATCH 1/8] ready to accept docs --- .vscode/settings.json | 3 ++- contentlayer.config.ts | 4 ++++ scripts/clean-build-files.mjs | 3 +++ scripts/generate-links/getDocs.mjs | 18 ++++++++++++++++++ scripts/generate-links/getOrders.mjs | 4 ++++ scripts/generate-links/index.mjs | 3 +++ src/components/SidebarSection.tsx | 3 +++ src/config/docs.json | 11 ++++++++++- src/lib/md-doc.ts | 1 + 9 files changed, 48 insertions(+), 2 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index ec5f2c5ac..60e280f54 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -25,7 +25,8 @@ "**/sway-by-example-lib": true, "**/migrations-and-disclosures": true, "**/fuel-book": true, - "**/verified-addresses": true + "**/verified-addresses": true, + "**/fuel-token-overview": true }, "git.ignoreLimitWarning": true, "[typescriptreact]": { diff --git a/contentlayer.config.ts b/contentlayer.config.ts index bcb4a8498..33c143a03 100644 --- a/contentlayer.config.ts +++ b/contentlayer.config.ts @@ -67,6 +67,7 @@ const includeDirs = [ 'docs/migrations-and-disclosures/docs/src', 'docs/fuel-book/docs/src', 'docs/verified-addresses/docs/src', + 'docs/fuel-token-overview/docs/src', 'docs/integration-docs/docs/src', // NIGHTLY DOCS 'docs/nightly/sway/docs/book/src', @@ -81,6 +82,7 @@ const includeDirs = [ 'docs/nightly/migrations-and-disclosures/docs/src', 'docs/nightly/fuel-book/docs/src', 'docs/nightly/verified-addresses/docs/src', + 'docs/nightly/fuel-token-overview/docs/src', 'docs/nightly/integration-docs/docs/src', ]; @@ -99,6 +101,7 @@ const excludeDirs = [ 'docs/migrations-and-disclosures/docs/src/SUMMARY.md', 'docs/fuel-book/docs/src/SUMMARY.md', 'docs/verified-addresses/docs/src/SUMMARY.md', + 'docs/fuel-token-overview/docs/src/SUMMARY.md', 'docs/integration-docs/docs/src/SUMMARY.md', // NIGHTLY DOCS 'docs/nightly/sway/docs/book/src/SUMMARY.md', @@ -110,6 +113,7 @@ const excludeDirs = [ '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/fuel-token-overview/docs/src/SUMMARY.md', 'docs/nightly/integration-docs/docs/src/SUMMARY.md', ]; diff --git a/scripts/clean-build-files.mjs b/scripts/clean-build-files.mjs index 909bc64e2..ff0698d26 100644 --- a/scripts/clean-build-files.mjs +++ b/scripts/clean-build-files.mjs @@ -28,6 +28,8 @@ const targetDirs = [ './docs/nightly/fuel-book', './docs/verified-addresses', './docs/nightly/verified-addresses', + './docs/fuel-token-overview', + './docs/nightly/fuel-token-overview', './docs/integration-docs', './docs/nightly/integration-docs', ]; @@ -77,6 +79,7 @@ const exclusions = { migrations_and_disclosures: ['migrations-and-disclosures/docs'], fuel_book: ['fuel-book/docs'], verified_addresses: ['verified-addresses/docs'], + fuel_token_overview: ['fuel-token-overview/docs'], integration_docs: ['integration-docs/docs'], }; diff --git a/scripts/generate-links/getDocs.mjs b/scripts/generate-links/getDocs.mjs index 372333093..6c2c2a848 100644 --- a/scripts/generate-links/getDocs.mjs +++ b/scripts/generate-links/getDocs.mjs @@ -109,6 +109,15 @@ export async function getDocs(key, order) { '!**/SUMMARY.md', ]; break; + case 'fuel-token-overview': + paths = [ + // BREAKING CHANGE LOG DOCS + './fuel-token-overview/docs/src/*.md', + './fuel-token-overview/docs/src/**/*.md', + // IGNORE ALL SUMMARY PAGES + '!**/SUMMARY.md', + ]; + break; case 'fuel-book': paths = [ // BREAKING CHANGE LOG DOCS @@ -127,6 +136,15 @@ export async function getDocs(key, order) { '!**/SUMMARY.md', ]; break; + case 'nightly-fuel-token-overview': + paths = [ + // BREAKING CHANGE LOG DOCS + './nightly/fuel-token-overview/docs/src/*.md', + './nightly/fuel-token-overview/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 b9fa5741a..3cb24e1c6 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', }, + 'fuel-token-overview': { + type: 'mdbook', + path: './fuel-token-overview/docs/src/SUMMARY.md', + }, 'verified-addresses': { type: 'mdbook', path: './verified-addresses/docs/src/SUMMARY.md', diff --git a/scripts/generate-links/index.mjs b/scripts/generate-links/index.mjs index edd567cfa..3aa607c98 100644 --- a/scripts/generate-links/index.mjs +++ b/scripts/generate-links/index.mjs @@ -106,6 +106,9 @@ function getSidebarName(key) { case 'verified-addresses': newKey = 'Verified Addresses'; break; + case 'fuel-token-overview': + newKey = 'Fuel Token Overview'; + break; case 'guides': newKey = 'Guides'; break; diff --git a/src/components/SidebarSection.tsx b/src/components/SidebarSection.tsx index 57feeec5a..d3b5e80ed 100644 --- a/src/components/SidebarSection.tsx +++ b/src/components/SidebarSection.tsx @@ -64,6 +64,9 @@ export function SidebarSection({ case 'Verified-addresses': githubLink = 'https://github.com/FuelLabs/verified-addresses'; break; + case 'Fuel-token-overview': + githubLink = 'https://github.com/FuelLabs/fuel-token-overview'; + break; case 'Guides': githubLink = 'https://github.com/FuelLabs/docs-hub'; break; diff --git a/src/config/docs.json b/src/config/docs.json index ff4d174a6..0135018c1 100644 --- a/src/config/docs.json +++ b/src/config/docs.json @@ -53,6 +53,15 @@ "image": "" } }, + "fuel-token-overview": { + "title": "Fuel Token Overview", + "slug": "fuel-token-overview", + "repository": "https://github.com/FuelLabs/fuel-token-overview", + "ogTags": { + "description": "An overview of the Fuel token", + "image": "" + } + }, "guides": { "title": "Guides", "slug": "guides", @@ -161,4 +170,4 @@ "image": "" } } -} +} \ No newline at end of file diff --git a/src/lib/md-doc.ts b/src/lib/md-doc.ts index d87220d0d..2aef3be81 100644 --- a/src/lib/md-doc.ts +++ b/src/lib/md-doc.ts @@ -73,6 +73,7 @@ export class Doc { .replace('docs/sway-by-example-lib/', '') .replace('docs/fuel-book/', '') .replace('docs/verified-addresses/', '') + .replace('docs/fuel-token-overview/', '') .replace('docs/fuel-specs/', '')}`; let pageLink = `${config.repository}${actualPath.replace( From 0d1d4019d0a677455a461ee0fa50e08bf328554d Mon Sep 17 00:00:00 2001 From: Call Delegation <106365423+calldelegation@users.noreply.github.com> Date: Thu, 12 Dec 2024 18:09:42 -0500 Subject: [PATCH 2/8] missing peices --- .gitmodules | 6 ++++++ docs/fuel-token-overview | 1 + docs/nightly/fuel-token-overview | 1 + 3 files changed, 8 insertions(+) create mode 160000 docs/fuel-token-overview create mode 160000 docs/nightly/fuel-token-overview diff --git a/.gitmodules b/.gitmodules index 1178951b9..6dde6f1af 100644 --- a/.gitmodules +++ b/.gitmodules @@ -103,3 +103,9 @@ [submodule "docs/nightly/fuel-book"] path = docs/nightly/fuel-book url = https://github.com/FuelLabs/fuel-book +[submodule "docs/fuel-token-overview"] + path = docs/fuel-token-overview + url = https://github.com/FuelLabs/fuel-token-overview.git +[submodule "docs/nightly/fuel-token-overview"] + path = docs/nightly/fuel-token-overview + url = https://github.com/FuelLabs/fuel-token-overview.git diff --git a/docs/fuel-token-overview b/docs/fuel-token-overview new file mode 160000 index 000000000..5d35a9257 --- /dev/null +++ b/docs/fuel-token-overview @@ -0,0 +1 @@ +Subproject commit 5d35a92579d3344140d5a2f0c4aaa4af89d6be94 diff --git a/docs/nightly/fuel-token-overview b/docs/nightly/fuel-token-overview new file mode 160000 index 000000000..5d35a9257 --- /dev/null +++ b/docs/nightly/fuel-token-overview @@ -0,0 +1 @@ +Subproject commit 5d35a92579d3344140d5a2f0c4aaa4af89d6be94 From e1a2f3cfa5d7149bd1a4bd9b096966a2582a6afe Mon Sep 17 00:00:00 2001 From: Call Delegation <106365423+calldelegation@users.noreply.github.com> Date: Sun, 15 Dec 2024 18:54:39 -0500 Subject: [PATCH 3/8] order --- scripts/generate-links/index.mjs | 1 + 1 file changed, 1 insertion(+) diff --git a/scripts/generate-links/index.mjs b/scripts/generate-links/index.mjs index 3aa607c98..2384499f6 100644 --- a/scripts/generate-links/index.mjs +++ b/scripts/generate-links/index.mjs @@ -126,6 +126,7 @@ function handleAllOrders(allOrders, folderPath, filename) { 'migrations-and-disclosures', 'intro', 'fuel-book', + 'fuel-token-overview', 'verified-addresses', 'guides', 'sway', From be5884b9ed01f8f209edddbd8d83b8f26c6661df Mon Sep 17 00:00:00 2001 From: Call Delegation <106365423+calldelegation@users.noreply.github.com> Date: Mon, 16 Dec 2024 01:15:12 -0500 Subject: [PATCH 4/8] ready for review --- docs/fuel-token-overview | 2 +- docs/nightly/fuel-token-overview | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/fuel-token-overview b/docs/fuel-token-overview index 5d35a9257..0f96a6460 160000 --- a/docs/fuel-token-overview +++ b/docs/fuel-token-overview @@ -1 +1 @@ -Subproject commit 5d35a92579d3344140d5a2f0c4aaa4af89d6be94 +Subproject commit 0f96a64606445ff8db4abae7a7b6bfa89bb56599 diff --git a/docs/nightly/fuel-token-overview b/docs/nightly/fuel-token-overview index 5d35a9257..0f96a6460 160000 --- a/docs/nightly/fuel-token-overview +++ b/docs/nightly/fuel-token-overview @@ -1 +1 @@ -Subproject commit 5d35a92579d3344140d5a2f0c4aaa4af89d6be94 +Subproject commit 0f96a64606445ff8db4abae7a7b6bfa89bb56599 From 9ee640430b38f615cfb1847f575719b84437a6ee Mon Sep 17 00:00:00 2001 From: Call Delegation <106365423+calldelegation@users.noreply.github.com> Date: Thu, 19 Dec 2024 00:47:02 -0500 Subject: [PATCH 5/8] preview --- docs/fuel-token-overview | 2 +- docs/nightly/fuel-token-overview | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/fuel-token-overview b/docs/fuel-token-overview index 0f96a6460..063703345 160000 --- a/docs/fuel-token-overview +++ b/docs/fuel-token-overview @@ -1 +1 @@ -Subproject commit 0f96a64606445ff8db4abae7a7b6bfa89bb56599 +Subproject commit 063703345a296ae80d1a387a8cbd09be2a627c57 diff --git a/docs/nightly/fuel-token-overview b/docs/nightly/fuel-token-overview index 0f96a6460..063703345 160000 --- a/docs/nightly/fuel-token-overview +++ b/docs/nightly/fuel-token-overview @@ -1 +1 @@ -Subproject commit 0f96a64606445ff8db4abae7a7b6bfa89bb56599 +Subproject commit 063703345a296ae80d1a387a8cbd09be2a627c57 From d22a2331c4f810188eeaf1265a77d04feeb7bb01 Mon Sep 17 00:00:00 2001 From: Call Delegation <106365423+calldelegation@users.noreply.github.com> Date: Thu, 19 Dec 2024 00:56:16 -0500 Subject: [PATCH 6/8] new new --- docs/fuel-token-overview | 2 +- docs/nightly/fuel-token-overview | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/fuel-token-overview b/docs/fuel-token-overview index 063703345..cedfca3f5 160000 --- a/docs/fuel-token-overview +++ b/docs/fuel-token-overview @@ -1 +1 @@ -Subproject commit 063703345a296ae80d1a387a8cbd09be2a627c57 +Subproject commit cedfca3f5bec2a9a96dfeefc37a10e2907554bb5 diff --git a/docs/nightly/fuel-token-overview b/docs/nightly/fuel-token-overview index 063703345..cedfca3f5 160000 --- a/docs/nightly/fuel-token-overview +++ b/docs/nightly/fuel-token-overview @@ -1 +1 @@ -Subproject commit 063703345a296ae80d1a387a8cbd09be2a627c57 +Subproject commit cedfca3f5bec2a9a96dfeefc37a10e2907554bb5 From fdaf14593337a2f4c76ae4cfde812139a8a8da79 Mon Sep 17 00:00:00 2001 From: Call Delegation <106365423+calldelegation@users.noreply.github.com> Date: Thu, 19 Dec 2024 03:40:46 -0500 Subject: [PATCH 7/8] v1 --- docs/fuel-token-overview | 2 +- docs/nightly/fuel-token-overview | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/fuel-token-overview b/docs/fuel-token-overview index cedfca3f5..8c8c2f75b 160000 --- a/docs/fuel-token-overview +++ b/docs/fuel-token-overview @@ -1 +1 @@ -Subproject commit cedfca3f5bec2a9a96dfeefc37a10e2907554bb5 +Subproject commit 8c8c2f75bc0e152b051a42cfd124c8d823164de3 diff --git a/docs/nightly/fuel-token-overview b/docs/nightly/fuel-token-overview index cedfca3f5..8c8c2f75b 160000 --- a/docs/nightly/fuel-token-overview +++ b/docs/nightly/fuel-token-overview @@ -1 +1 @@ -Subproject commit cedfca3f5bec2a9a96dfeefc37a10e2907554bb5 +Subproject commit 8c8c2f75bc0e152b051a42cfd124c8d823164de3 From 00370857f9fa1f7d8c78d7478799fec7d5afcfa1 Mon Sep 17 00:00:00 2001 From: Call Delegation <106365423+calldelegation@users.noreply.github.com> Date: Thu, 19 Dec 2024 03:46:07 -0500 Subject: [PATCH 8/8] rebuild --- docs/fuel-token-overview | 2 +- docs/nightly/fuel-token-overview | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/fuel-token-overview b/docs/fuel-token-overview index 8c8c2f75b..847886540 160000 --- a/docs/fuel-token-overview +++ b/docs/fuel-token-overview @@ -1 +1 @@ -Subproject commit 8c8c2f75bc0e152b051a42cfd124c8d823164de3 +Subproject commit 847886540cdd08ed77b05f96ff054e7b24bc3dc7 diff --git a/docs/nightly/fuel-token-overview b/docs/nightly/fuel-token-overview index 8c8c2f75b..847886540 160000 --- a/docs/nightly/fuel-token-overview +++ b/docs/nightly/fuel-token-overview @@ -1 +1 @@ -Subproject commit 8c8c2f75bc0e152b051a42cfd124c8d823164de3 +Subproject commit 847886540cdd08ed77b05f96ff054e7b24bc3dc7