docs: ensure docs are up to date & use stable links in sdk reference (#2368)

* docs: ensure docs are up to date & use stable links in sdk reference

* fix(ci): lint docs output

Author: jakehobbs

.github/workflows/on-pull-request.yml

@@ -195,6 +195,13 @@ jobs:
       - name: Typecheck Test
         run: yarn test:typecheck
 
+      - name: Check SDK reference docs are up to date
+        run: |
+          yarn docs:sdk
+          yarn lint:write
+          git diff --exit-code docs/pages/reference/ || \
+            (echo "::error::SDK reference docs are out of date. Run 'yarn docs:sdk' and commit the changes." && exit 1)
+
   build_ios:
     name: Build iOS
     runs-on: macos-14

.gitignore

@@ -38,6 +38,9 @@ vocs.config.tsx.timestamp-*.mjs
 bin
 **/.turbo
 
+# TypeDoc generated media (source files copied for source links)
+docs/pages/reference/_media
+
 # Turborepo
 .turbo
 

docs/pages/reference/aa-sdk/core/src/classes/AccountNotFoundError.mdx

@@ -7,7 +7,7 @@ layout: reference
 
 {/* This file is auto-generated by TypeDoc. Do not edit manually. */}
 
-Defined in: [aa-sdk/core/src/errors/account.ts:8](https://github.com/alchemyplatform/aa-sdk/blob/64e8cbabbf2fde59a17e85374123e899334dc927/aa-sdk/core/src/errors/account.ts#L8)
+Defined in: [aa-sdk/core/src/errors/account.ts:8](https://github.com/alchemyplatform/aa-sdk/blob/main/aa-sdk/core/src/errors/account.ts#L8)
 
 This error is thrown when an account could not be found to execute a specific action. It extends the `BaseError` class.
 
@@ -23,7 +23,7 @@ This error is thrown when an account could not be found to execute a specific ac
 new AccountNotFoundError(): AccountNotFoundError;
 ```
 
-Defined in: [aa-sdk/core/src/errors/account.ts:15](https://github.com/alchemyplatform/aa-sdk/blob/64e8cbabbf2fde59a17e85374123e899334dc927/aa-sdk/core/src/errors/account.ts#L15)
+Defined in: [aa-sdk/core/src/errors/account.ts:15](https://github.com/alchemyplatform/aa-sdk/blob/main/aa-sdk/core/src/errors/account.ts#L15)
 
 Constructor for initializing an error message indicating that an account could not be found to execute the specified action.
 

docs/pages/reference/aa-sdk/core/src/classes/AccountRequiresOwnerError.mdx

@@ -7,7 +7,7 @@ layout: reference
 
 {/* This file is auto-generated by TypeDoc. Do not edit manually. */}
 
-Defined in: [aa-sdk/core/src/errors/account.ts:138](https://github.com/alchemyplatform/aa-sdk/blob/64e8cbabbf2fde59a17e85374123e899334dc927/aa-sdk/core/src/errors/account.ts#L138)
+Defined in: [aa-sdk/core/src/errors/account.ts:138](https://github.com/alchemyplatform/aa-sdk/blob/main/aa-sdk/core/src/errors/account.ts#L138)
 
 Represents an error that occurs when an account requires an owner to execute but none is provided.
 
@@ -23,7 +23,7 @@ Represents an error that occurs when an account requires an owner to execute but
 new AccountRequiresOwnerError(accountType): AccountRequiresOwnerError;
 ```
 
-Defined in: [aa-sdk/core/src/errors/account.ts:146](https://github.com/alchemyplatform/aa-sdk/blob/64e8cbabbf2fde59a17e85374123e899334dc927/aa-sdk/core/src/errors/account.ts#L146)
+Defined in: [aa-sdk/core/src/errors/account.ts:146](https://github.com/alchemyplatform/aa-sdk/blob/main/aa-sdk/core/src/errors/account.ts#L146)
 
 Constructs an error indicating that an account of the specified type requires an owner to execute.
 

docs/pages/reference/aa-sdk/core/src/classes/BaseError.mdx

@@ -7,7 +7,7 @@ layout: reference
 
 {/* This file is auto-generated by TypeDoc. Do not edit manually. */}
 
-Defined in: [aa-sdk/core/src/errors/base.ts:24](https://github.com/alchemyplatform/aa-sdk/blob/64e8cbabbf2fde59a17e85374123e899334dc927/aa-sdk/core/src/errors/base.ts#L24)
+Defined in: [aa-sdk/core/src/errors/base.ts:24](https://github.com/alchemyplatform/aa-sdk/blob/main/aa-sdk/core/src/errors/base.ts#L24)
 
 A custom error class that extends from `ViemBaseError`. This class allows for error messages to include links to relevant documentation based on provided `docsPath` and `docsSlug` parameters.
 This is based on on viem's BaseError type (obviously from the import and extend)
@@ -55,7 +55,7 @@ we want the errors here to point to our docs if we supply a docsPath though
 new BaseError(shortMessage, args): BaseError;
 ```
 
-Defined in: [aa-sdk/core/src/errors/base.ts:28](https://github.com/alchemyplatform/aa-sdk/blob/64e8cbabbf2fde59a17e85374123e899334dc927/aa-sdk/core/src/errors/base.ts#L28)
+Defined in: [aa-sdk/core/src/errors/base.ts:28](https://github.com/alchemyplatform/aa-sdk/blob/main/aa-sdk/core/src/errors/base.ts#L28)
 
 #### Parameters
 

docs/pages/reference/aa-sdk/core/src/classes/BatchExecutionNotSupportedError.mdx

@@ -7,7 +7,7 @@ layout: reference
 
 {/* This file is auto-generated by TypeDoc. Do not edit manually. */}
 
-Defined in: [aa-sdk/core/src/errors/account.ts:122](https://github.com/alchemyplatform/aa-sdk/blob/64e8cbabbf2fde59a17e85374123e899334dc927/aa-sdk/core/src/errors/account.ts#L122)
+Defined in: [aa-sdk/core/src/errors/account.ts:122](https://github.com/alchemyplatform/aa-sdk/blob/main/aa-sdk/core/src/errors/account.ts#L122)
 
 Represents an error indicating that batch execution is not supported for a specific account type.
 
@@ -23,7 +23,7 @@ Represents an error indicating that batch execution is not supported for a speci
 new BatchExecutionNotSupportedError(accountType): BatchExecutionNotSupportedError;
 ```
 
-Defined in: [aa-sdk/core/src/errors/account.ts:130](https://github.com/alchemyplatform/aa-sdk/blob/64e8cbabbf2fde59a17e85374123e899334dc927/aa-sdk/core/src/errors/account.ts#L130)
+Defined in: [aa-sdk/core/src/errors/account.ts:130](https://github.com/alchemyplatform/aa-sdk/blob/main/aa-sdk/core/src/errors/account.ts#L130)
 
 Constructs an error message indicating that batch execution is not supported by the specified account type.
 

docs/pages/reference/aa-sdk/core/src/classes/ChainNotFoundError.mdx

@@ -7,7 +7,7 @@ layout: reference
 
 {/* This file is auto-generated by TypeDoc. Do not edit manually. */}
 
-Defined in: [aa-sdk/core/src/errors/client.ts:46](https://github.com/alchemyplatform/aa-sdk/blob/64e8cbabbf2fde59a17e85374123e899334dc927/aa-sdk/core/src/errors/client.ts#L46)
+Defined in: [aa-sdk/core/src/errors/client.ts:46](https://github.com/alchemyplatform/aa-sdk/blob/main/aa-sdk/core/src/errors/client.ts#L46)
 
 Error class representing a "Chain Not Found" error, typically thrown when no chain is supplied to the client.
 
@@ -23,7 +23,7 @@ Error class representing a "Chain Not Found" error, typically thrown when no cha
 new ChainNotFoundError(): ChainNotFoundError;
 ```
 
-Defined in: [aa-sdk/core/src/errors/client.ts:52](https://github.com/alchemyplatform/aa-sdk/blob/64e8cbabbf2fde59a17e85374123e899334dc927/aa-sdk/core/src/errors/client.ts#L52)
+Defined in: [aa-sdk/core/src/errors/client.ts:52](https://github.com/alchemyplatform/aa-sdk/blob/main/aa-sdk/core/src/errors/client.ts#L52)
 
 Initializes a new instance of the error message with a default message indicating that no chain was supplied to the client.
 

docs/pages/reference/aa-sdk/core/src/classes/DefaultFactoryNotDefinedError.mdx

@@ -7,7 +7,7 @@ layout: reference
 
 {/* This file is auto-generated by TypeDoc. Do not edit manually. */}
 
-Defined in: [aa-sdk/core/src/errors/account.ts:38](https://github.com/alchemyplatform/aa-sdk/blob/64e8cbabbf2fde59a17e85374123e899334dc927/aa-sdk/core/src/errors/account.ts#L38)
+Defined in: [aa-sdk/core/src/errors/account.ts:38](https://github.com/alchemyplatform/aa-sdk/blob/main/aa-sdk/core/src/errors/account.ts#L38)
 
 Represents an error that is thrown when no default factory is defined for a specific account type on a given chain and entry point version.
 This error suggests providing an override via the `factoryAddress` parameter when creating an account.
@@ -27,7 +27,7 @@ new DefaultFactoryNotDefinedError(
    version): DefaultFactoryNotDefinedError;
 ```
 
-Defined in: [aa-sdk/core/src/errors/account.ts:48](https://github.com/alchemyplatform/aa-sdk/blob/64e8cbabbf2fde59a17e85374123e899334dc927/aa-sdk/core/src/errors/account.ts#L48)
+Defined in: [aa-sdk/core/src/errors/account.ts:48](https://github.com/alchemyplatform/aa-sdk/blob/main/aa-sdk/core/src/errors/account.ts#L48)
 
 Constructs an error message indicating that no default factory was found for the given account type, chain, and entry point version.
 

docs/pages/reference/aa-sdk/core/src/classes/EntityIdOverrideError.mdx

@@ -7,7 +7,7 @@ layout: reference
 
 {/* This file is auto-generated by TypeDoc. Do not edit manually. */}
 
-Defined in: [aa-sdk/core/src/errors/client.ts:96](https://github.com/alchemyplatform/aa-sdk/blob/64e8cbabbf2fde59a17e85374123e899334dc927/aa-sdk/core/src/errors/client.ts#L96)
+Defined in: [aa-sdk/core/src/errors/client.ts:96](https://github.com/alchemyplatform/aa-sdk/blob/main/aa-sdk/core/src/errors/client.ts#L96)
 
 Error class denoting that the provided entity id is invalid because it's overriding the native entity id.
 
@@ -23,7 +23,7 @@ Error class denoting that the provided entity id is invalid because it's overrid
 new EntityIdOverrideError(): EntityIdOverrideError;
 ```
 
-Defined in: [aa-sdk/core/src/errors/client.ts:102](https://github.com/alchemyplatform/aa-sdk/blob/64e8cbabbf2fde59a17e85374123e899334dc927/aa-sdk/core/src/errors/client.ts#L102)
+Defined in: [aa-sdk/core/src/errors/client.ts:102](https://github.com/alchemyplatform/aa-sdk/blob/main/aa-sdk/core/src/errors/client.ts#L102)
 
 Initializes a new instance of the error message with a default message indicating that the nonce key is invalid.
 

docs/pages/reference/aa-sdk/core/src/classes/EntryPointNotFoundError.mdx

@@ -7,7 +7,7 @@ layout: reference
 
 {/* This file is auto-generated by TypeDoc. Do not edit manually. */}
 
-Defined in: [aa-sdk/core/src/errors/entrypoint.ts:7](https://github.com/alchemyplatform/aa-sdk/blob/64e8cbabbf2fde59a17e85374123e899334dc927/aa-sdk/core/src/errors/entrypoint.ts#L7)
+Defined in: [aa-sdk/core/src/errors/entrypoint.ts:7](https://github.com/alchemyplatform/aa-sdk/blob/main/aa-sdk/core/src/errors/entrypoint.ts#L7)
 
 Represents an error thrown when an entry point is not found for a specific chain and entry point version. This error indicates that a default entry point does not exist for the given chain and version, and suggests providing an override.
 
@@ -23,7 +23,7 @@ Represents an error thrown when an entry point is not found for a specific chain
 new EntryPointNotFoundError(chain, entryPointVersion): EntryPointNotFoundError;
 ```
 
-Defined in: [aa-sdk/core/src/errors/entrypoint.ts:16](https://github.com/alchemyplatform/aa-sdk/blob/64e8cbabbf2fde59a17e85374123e899334dc927/aa-sdk/core/src/errors/entrypoint.ts#L16)
+Defined in: [aa-sdk/core/src/errors/entrypoint.ts:16](https://github.com/alchemyplatform/aa-sdk/blob/main/aa-sdk/core/src/errors/entrypoint.ts#L16)
 
 Constructs an error message indicating that no default entry point exists for the given chain and entry point version.