Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add info #541

Merged
merged 10 commits into from
Dec 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -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
3 changes: 2 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -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]": {
Expand Down
4 changes: 4 additions & 0 deletions contentlayer.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand All @@ -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',
];

Expand All @@ -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',
Expand All @@ -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',
];

Expand Down
1 change: 1 addition & 0 deletions docs/fuel-token-overview
Submodule fuel-token-overview added at 847886
1 change: 1 addition & 0 deletions docs/nightly/fuel-token-overview
Submodule fuel-token-overview added at 847886
3 changes: 3 additions & 0 deletions scripts/clean-build-files.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -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',
];
Expand Down Expand Up @@ -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'],
};

Expand Down
18 changes: 18 additions & 0 deletions scripts/generate-links/getDocs.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
4 changes: 4 additions & 0 deletions scripts/generate-links/getOrders.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
4 changes: 4 additions & 0 deletions scripts/generate-links/index.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -123,6 +126,7 @@ function handleAllOrders(allOrders, folderPath, filename) {
'migrations-and-disclosures',
'intro',
'fuel-book',
'fuel-token-overview',
'verified-addresses',
'guides',
'sway',
Expand Down
3 changes: 3 additions & 0 deletions src/components/SidebarSection.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
11 changes: 10 additions & 1 deletion src/config/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -161,4 +170,4 @@
"image": ""
}
}
}
}
1 change: 1 addition & 0 deletions src/lib/md-doc.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
Loading