Skip to content

Commit

Permalink
docs: Add verified assets (#453)
Browse files Browse the repository at this point in the history
* ready for review

* fix

* ready for review

* update submodules
  • Loading branch information
calldelegation authored Oct 16, 2024
1 parent 0113e8e commit 745b96f
Show file tree
Hide file tree
Showing 12 changed files with 56 additions and 1 deletion.
6 changes: 6 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -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]": {
Expand Down
4 changes: 4 additions & 0 deletions contentlayer.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand All @@ -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',
];

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

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

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 @@ -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
Expand All @@ -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
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',
},
'verified-addresses': {
type: 'mdbook',
path: './verified-addresses/docs/src/SUMMARY.md',
},
sway: {
type: 'mdbook',
path: './sway/docs/book/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 @@ -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;
Expand All @@ -120,6 +123,7 @@ function handleAllOrders(allOrders, folderPath, filename) {
'migrations-and-disclosures',
'intro',
'fuel-book',
'verified-addresses',
'guides',
'sway',
'sway-libs',
Expand Down
3 changes: 3 additions & 0 deletions src/components/SidebarSection.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
9 changes: 9 additions & 0 deletions src/config/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
1 change: 1 addition & 0 deletions src/lib/md-doc.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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/', '')}`;

Expand Down

0 comments on commit 745b96f

Please sign in to comment.