improve comments

FuelLabs · nedsalk · Feb 8, 2025 · Jan 14, 2025 · Jan 17, 2025 · Jan 17, 2025
commit cf5b022b42523e7641b8e9aafdfddcdb397498f6
@@ -25,8 +25,9 @@ export default defineConfig({
     // because opening in the same tab doesn't work in the preview
     return code.replace(/(<a\s+[^>]*href="\/api\/[^"]*")/g, '$1 target="_blank" rel="noreferrer"');
   },
-  // finds dead DOCS_API_URL links
-  // which get replaced later in the markdown transformer
+  // Finds dead DOCS_API_URL links and fails,
+  // but they get replaced later in the markdown transformer.
+  // We have the md link checker workflow which covers this.
   ignoreDeadLinks: true,
   head: [
     ['link', { rel: 'icon', href: '/fuels-ts/favicon.ico', type: 'image/png' }],

diff --git a/scripts/lint-md-links.ts b/scripts/lint-md-links.ts
 #!/usr/bin/env node
 import { exec, execSync, spawn } from 'child_process';
 import { readFileSync, writeFileSync } from 'fs';
 import { globSync } from 'glob';
 import { cwd } from 'process';

 const { log } = console;
	#!/usr/bin/env node
	import { exec, execSync, spawn } from 'child_process';
Check warning on line 2 in scripts/lint-md-links.ts GitHub Actions / Lint `'exec' is defined but never used`
	import { readFileSync, writeFileSync } from 'fs';
	import { globSync } from 'glob';
	import { cwd } from 'process';
Check warning on line 5 in scripts/lint-md-links.ts GitHub Actions / Lint `'cwd' is defined but never used`

	const { log } = console;