chore: ship API documentation (#3413)

* chore: ship an isolated version of the API documentation

* chore: changeset

* chore: update changeset

* chore: rebuild

* chore: rebuild for API docs

* chore: ignore api link lint

* chore: rebuild for API docs

* chore: rebuild for text lint

* chore: rebuild

* chore: update account test import

Co-authored-by: Peter Smith <[email protected]>

* chore: update utils test import

Co-authored-by: Peter Smith <[email protected]>

* Revert "chore: update account test import"

This reverts commit 4673f67.

* Revert "chore: update utils test import"

This reverts commit 63442d7.

---------

Co-authored-by: Peter Smith <[email protected]>

.changeset/config.json

@@ -21,6 +21,7 @@
     "template-nextjs",
     "create-fuels-counter-guide",
     "demo-wallet-sdk-react",
-    "template-vite"
+    "template-vite",
+    "docs-api"
   ]
 }

.changeset/quiet-cups-turn.md

@@ -0,0 +1,4 @@
+---
+---
+
+chore: ship API documentation

.knip.json

@@ -8,7 +8,8 @@
     "templates/**",
     "/apps/docs-snippets/**",
     "/apps/docs-snippets2/**/*.test.ts",
-    "apps/create-fuels-counter-guide/**"
+    "apps/create-fuels-counter-guide/**",
+    "apps/docs-api/**"
   ],
   "ignoreDependencies": [
     "autocannon",

apps/docs-api/.gitignore

@@ -0,0 +1 @@
+src/api

apps/docs-api/index.md

@@ -0,0 +1,28 @@
+<picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/FuelLabs/fuels-ts/master/apps/docs/src/public/fuels-ts-logo-dark.png">
+    <img alt="Fuels-ts SDK logo" width="400px" src="https://raw.githubusercontent.com/FuelLabs/fuels-ts/master/apps/docs/src/public/fuels-ts-logo-light.png">
+</picture>
+
+**fuels-ts** is a library for interacting with **Fuel v2**.
+
+[![test](https://github.com/FuelLabs/fuels-ts/actions/workflows/test.yaml/badge.svg)](https://github.com/FuelLabs/fuels-ts/actions/workflows/test.yaml)
+[![npm](https://img.shields.io/npm/v/fuels)](https://www.npmjs.com/package/fuels)
+[![docs](https://img.shields.io/badge/docs-fuels.ts-brightgreen.svg?style=flat)](https://docs.fuel.network/docs/fuels-ts/)
+[![discord](https://img.shields.io/badge/chat%20on-discord-orange?&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/xfpK4Pe)
+
+# Modules
+
+- [abi-coder](./modules/_fuel_ts_abi_coder.html)
+- [abi-typegen](./modules/_fuel_ts_abi_typegen.html)
+- [account](./modules/_fuel_ts_account.html)
+- [address](./modules/_fuel_ts_address.html)
+- [crypto](./modules/_fuel_ts_crypto.html)
+- [errors](./modules/_fuel_ts_errors.html)
+- [hasher](./modules/_fuel_ts_hasher.html)
+- [interfaces](./modules/_fuel_ts_interfaces.html)
+- [math](./modules/_fuel_ts_math.html)
+- [predicate](./modules/_fuel_ts_predicate.html)
+- [program](./modules/_fuel_ts_program.html)
+- [script](./modules/_fuel_ts_script.html)
+- [transactions](./modules/_fuel_ts_transactions.html)
+- [utils](./modules/_fuel_ts_utils.html)

apps/docs-api/package.json

@@ -0,0 +1,17 @@
+{
+  "private": true,
+  "name": "docs-api",
+  "version": "0.0.1",
+  "description": "",
+  "type": "module",
+  "scripts": {
+    "build": "typedoc"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "fuels": "workspace:*",
+    "typedoc": "^0.26.3"
+  }
+}

apps/docs-api/typedoc.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPointStrategy": "packages",
+  "entryPoints": [
+    "../../packages/abi-coder",
+    "../../packages/abi-typegen",
+    "../../packages/address",
+    "../../packages/interfaces",
+    "../../packages/predicate",
+    "../../packages/account",
+    "../../packages/program",
+    "../../packages/contract",
+    "../../packages/script",
+    "../../packages/utils",
+    "../../packages/crypto",
+    "../../packages/errors",
+    "../../packages/hasher",
+    "../../packages/math",
+    "../../packages/transactions"
+  ],
+  "out": "src/api",
+  "readme": "./index.md",
+  "name": "Fuels TS SDK API Documentation",
+  "navigationLinks": {
+    "Docs": "https://docs.fuel.network/docs/intro/what-is-fuel/",
+    "GitHub": "https://github.com/FuelLabs/fuels-ts"
+  }
+}

apps/docs/src/index.md

@@ -20,3 +20,7 @@ Using the SDK you can:
 ## Version
 
 This documentation was generated using Fuels `v{{fuels}}`, Fuel Core `v{{fuelCore}}`, Sway `v{{forc}}`, and Forc `v{{forc}}`.
+
+## API Documentation
+
+The Complete API documentation for the SDK is available [here](https://fuels-ts-docs-api.vercel.app/).

packages/abi-coder/typedoc.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"],
+  "readme": "none"
+}

packages/abi-typegen/typedoc.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"],
+  "readme": "none"
+}

packages/account/typedoc.json

@@ -1,5 +1,6 @@
 {
   "$schema": "https://typedoc.org/schema.json",
   "extends": ["../../typedoc.base.json"],
-  "entryPoints": ["src/index.ts"]
+  "entryPoints": ["src/index.ts"],
+  "readme": "none"
 }

packages/address/typedoc.json

@@ -1,5 +1,6 @@
 {
   "$schema": "https://typedoc.org/schema.json",
   "extends": ["../../typedoc.base.json"],
-  "entryPoints": ["src/index.ts"]
+  "entryPoints": ["src/index.ts"],
+  "readme": "none"
 }

packages/contract/typedoc.json

@@ -1,5 +1,6 @@
 {
   "$schema": "https://typedoc.org/schema.json",
   "extends": ["../../typedoc.base.json"],
-  "entryPoints": ["src/index.ts", "src/test-utils.ts"]
+  "entryPoints": ["src/index.ts", "src/test-utils.ts"],
+  "readme": "none"
 }

packages/crypto/typedoc.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"],
+  "readme": "none"
+}

packages/errors/typedoc.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"],
+  "readme": "none"
+}

packages/hasher/typedoc.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"],
+  "readme": "none"
+}

packages/interfaces/typedoc.json

@@ -1,5 +1,6 @@
 {
   "$schema": "https://typedoc.org/schema.json",
   "extends": ["../../typedoc.base.json"],
-  "entryPoints": ["src/index.ts"]
+  "entryPoints": ["src/index.ts"],
+  "readme": "none"
 }

packages/math/typedoc.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"],
+  "readme": "none"
+}

packages/program/typedoc.json

@@ -1,5 +1,6 @@
 {
   "$schema": "https://typedoc.org/schema.json",
   "extends": ["../../typedoc.base.json"],
-  "entryPoints": ["src/index.ts"]
+  "entryPoints": ["src/index.ts"],
+  "readme": "none"
 }

packages/script/typedoc.json

@@ -1,5 +1,6 @@
 {
   "$schema": "https://typedoc.org/schema.json",
   "extends": ["../../typedoc.base.json"],
-  "entryPoints": ["src/index.ts"]
+  "entryPoints": ["src/index.ts"],
+  "readme": "none"
 }

packages/transactions/typedoc.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"],
+  "readme": "none"
+}

packages/utils/typedoc.json

@@ -1,5 +1,6 @@
 {
   "$schema": "https://typedoc.org/schema.json",
   "extends": ["../../typedoc.base.json"],
-  "entryPoints": ["src/index.ts", "src/test-utils/index.ts"]
+  "entryPoints": ["src/index.ts", "src/test-utils/index.ts"],
+  "readme": "none"
 }