fix: deactivate the API docs for now

[nud3l]

The typedoc plugin is causing a build error for the whole website. This PR removes the API docs for now until we find a better workaround.

Building the API docs directly with typedoc yields no errors.

[ERROR] Error: Unable to build website for locale en.
    at tryToBuildLocale (/Users/nud3l/code/bob/docs/node_modules/@docusaurus/core/lib/commands/build.js:53:19)
    at async /Users/nud3l/code/bob/docs/node_modules/@docusaurus/core/lib/commands/build.js:64:9
    at async mapAsyncSequential (/Users/nud3l/code/bob/docs/node_modules/@docusaurus/utils/lib/jsUtils.js:20:24)
    at async Command.build (/Users/nud3l/code/bob/docs/node_modules/@docusaurus/core/lib/commands/build.js:62:5) {
  [cause]: Error: Docusaurus static site generation failed for 1 paths:
  - "/docs/api/ts-sdk/interfaces/electrs.ElectrsClient"
      at generateStaticFiles (/Users/nud3l/code/bob/docs/node_modules/@docusaurus/core/lib/ssg.js:85:15)
      at async executeSSG (/Users/nud3l/code/bob/docs/node_modules/@docusaurus/core/lib/commands/build.js:146:23)
      ... 4 lines matching cause stack trace ...
      at async Command.build (/Users/nud3l/code/bob/docs/node_modules/@docusaurus/core/lib/commands/build.js:62:5) {
    [cause]: AggregateError
        at generateStaticFiles (/Users/nud3l/code/bob/docs/node_modules/@docusaurus/core/lib/ssg.js:86:20)
        at async executeSSG (/Users/nud3l/code/bob/docs/node_modules/@docusaurus/core/lib/commands/build.js:146:23)
        at async buildLocale (/Users/nud3l/code/bob/docs/node_modules/@docusaurus/core/lib/commands/build.js:126:31)
        at async tryToBuildLocale (/Users/nud3l/code/bob/docs/node_modules/@docusaurus/core/lib/commands/build.js:46:13)
        at async /Users/nud3l/code/bob/docs/node_modules/@docusaurus/core/lib/commands/build.js:64:9
        at async mapAsyncSequential (/Users/nud3l/code/bob/docs/node_modules/@docusaurus/utils/lib/jsUtils.js:20:24)
        at async Command.build (/Users/nud3l/code/bob/docs/node_modules/@docusaurus/core/lib/commands/build.js:62:5) {
      [errors]: [
        Error: Can't render static file for pathname "/docs/api/ts-sdk/interfaces/electrs.ElectrsClient"
            at generateStaticFile (/Users/nud3l/code/bob/docs/node_modules/@docusaurus/core/lib/ssg.js:119:15)
            at runNextTicks (node:internal/process/task_queues:60:5)
            at process.processImmediate (node:internal/timers:447:9)
            at async /Users/nud3l/code/bob/docs/node_modules/p-map/index.js:57:22 {
          [cause]: ReferenceError: string is not defined
              at _createMdxContent (server.bundle.js:2636:24)
              at MDXContent (server.bundle.js:2775:8)
              at Uc (server.bundle.js:44689:44)
              at Xc (server.bundle.js:44691:253)
              at Z (server.bundle.js:44697:89)
              at Xc (server.bundle.js:44695:231)
              at Z (server.bundle.js:44697:89)
              at Xc (server.bundle.js:44691:481)
              at Z (server.bundle.js:44697:89)
              at Xc (server.bundle.js:44691:481)
        }
      ]
    }
  }
}

[changeset-bot[bot]]

⚠️ No Changeset found

Latest commit: 50b9d740efadcdee5ceaac4f332ae3b851b23005

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[vercel[bot]]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
bob	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 30, 2024 5:02am