Add Husky pre-commit and pre-push hooks for automated doc checks

.husky/pre-push

@@ -0,0 +1,6 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+echo "🔍 Running automatic fixes before pushing..."
+pnpm fix
+echo "✅ Fixes applied - your contribution is now ready for review!"

package.json

@@ -8,7 +8,7 @@
     "fix": "eslint . --ext mdx --fix && pnpm spellcheck:fix && pnpm breadcrumbs && pnpm fix-redirects && pnpm metadata-batch-cli",
     "spellcheck:lint": "cspell lint \"**/*.mdx\"",
     "spellcheck:fix": "cspell --words-only --unique \"**/*.mdx\" | sort --ignore-case | uniq > words.txt",
-    "breadcrumbs": "NODE_NO_WARNINGS=1 npx ts-node-esm --skip-project utils/create-breadcrumbs.ts",
+    "breadcrumbs": "NODE_NO_WARNINGS=1 node --loader ts-node/esm utils/create-breadcrumbs.ts",
     "check-breadcrumbs": "NODE_NO_WARNINGS=1 node --loader ts-node/esm utils/breadcrumbs.ts",
     "check-redirects": "NODE_NO_WARNINGS=1 node --loader ts-node/esm utils/redirects.ts",
     "fix-redirects": "NODE_NO_WARNINGS=1 node --loader ts-node/esm utils/fix-redirects.ts",
@@ -34,6 +34,7 @@
     "clsx": "^2.1.1",
     "dotenv": "^16.4.7",
     "escape-string-regexp": "^5.0.0",
+    "glob": "^11.0.1",
     "js-yaml": "^4.1.0",
     "next": "14.2.21",
     "next-sitemap": "^4.2.3",
@@ -50,6 +51,7 @@
     "@eth-optimism/core-utils": "^0.13.1",
     "@eth-optimism/sdk": "^3.1.6",
     "@types/dotenv": "^8.2.3",
+    "@types/glob": "^8.1.0",
     "@types/js-yaml": "^4.0.9",
     "@types/node": "18.11.10",
     "cspell": "^8.1.3",

pages/app-developers/starter-kit.mdx

@@ -104,7 +104,7 @@ Here's a breakdown of what's under the hood:
   This section defines parameters for deploying token contracts.
 
   | Parameter | Description                                                                                                                                                               | Example                                |
-  | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- |
+  | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- |
   | `salt`    | A unique identifier used for deploying token contracts via \[`Create2`]. This value along with the contract bytecode ensures that contract deployments are deterministic. | `salt = "ethers phoenix"`              |
   | `chains`  | Lists the chains where the token will be deployed. Each chain must correspond to an entry in the `[rpc_endpoints]` section of `foundry.toml`.                             | `chains = ["op_chain_a","op_chain_b"]` |
 

pages/app-developers/tutorials/transactions/sdk-estimate-costs.mdx

@@ -188,7 +188,7 @@ Here you'll estimate the cost of a simple transaction that sends a small amount
 </Steps>
 
 <Callout type="info">
-Estimates will never be entirely accurate due to network conditions and gas price fluctuations, but they should be close to the actual costs.
+Estimates will never be entirely accurate due to network conditions and gas price fluctuation, but they should be close to the actual costs.
 </Callout>
 
 ## Next steps

public/_redirects

@@ -20,6 +20,7 @@
 /builders/tools/oracles             /app-developers/tools/build/oracles
 /builders/tools/nft-tools           /app-developers/tools/build/nft-tools
 /builders/tools/account-abstraction /app-developers/tools/build/account-abstraction
+
 /builders/tools/analytics-tools     /app-developers/tools/build/analytics-tools
 /builders/tools/*                   /app-developers/tools/:splat
 

utils/create-breadcrumbs.ts

@@ -2,7 +2,7 @@ import * as fs from 'fs/promises';
 import * as path from 'path';
 import matter from 'gray-matter';
 
-const rootDir: string = path.join(__dirname, '..', 'pages');
+const rootDir = path.join(process.cwd(), 'pages');
 
 interface FileInfo {
   title: string;

utils/fix-redirects.ts

@@ -1,6 +1,3 @@
-#!/usr/bin/env node
-// Save this file as utils/fix-redirects.ts
-
 import * as fs from 'fs/promises';
 import * as path from 'path';