Update typedoc config to consider broader files and build docs on release

Author: 9inpachi

.github/workflows/publish.yml

@@ -45,9 +45,12 @@ jobs:
           git config user.name "${GITHUB_ACTOR}"
           git config user.email "${GITHUB_ACTOR}@users.noreply.github.com"
 
-      - name: Build
+      - name: Build package
         run: pnpm build
 
+      - name: Build docs
+        run: pnpm docs:build
+
       - name: Publish package
         run: pnpm release --increment ${{ inputs.increment }}
         env:

README.md

@@ -1,10 +1,11 @@
 <div align="center">
   <h1>Puffer SDK</h1>
 
-  <img alt="GitHub license" src="https://img.shields.io/github/license/pufferfinance/puffer-sdk?color=limegreen">
-  <img alt="Downloads npm" src="https://img.shields.io/npm/dm/@pufferfinance/puffer-sdk?color=limegreen">
-  <img alt="Version npm" src="https://img.shields.io/npm/v/@pufferfinance/puffer-sdk?label=version">
-  <!-- ADD COVERAGE -->
+  <img alt="build" src="https://github.com/pufferfinance/puffer-sdk/actions/workflows/build-and-test.yml/badge.svg?branch=main" />
+  <img alt="license" src="https://img.shields.io/github/license/pufferfinance/puffer-sdk?color=limegreen" />
+  <img alt="npm downloads" src="https://img.shields.io/npm/dm/@pufferfinance/puffer-sdk?color=limegreen&logo=npm" />
+  <img alt="npm version" src="https://img.shields.io/npm/v/@pufferfinance/puffer-sdk?label=version&logo=npm" />
+  <!-- TODO: ADD COVERAGE BADGE -->
 
   <p>SDK to seamlessly interact with puffer smart contracts<p>
 </div>

docs/docusaurus.config.ts

@@ -144,7 +144,8 @@ const config: Config = {
       // https://typedoc-plugin-markdown.org/plugins/docusaurus/options
       // https://typedoc-plugin-markdown.org/docs/options
       {
-        entryPoints: '../lib/api',
+        // Consider all files in subdirectories of the `lib` directory.
+        entryPoints: '../lib/*/**',
         exclude: '**/*+(test|spec|index).ts',
         entryPointStrategy: 'expand',
         tsconfig: '../tsconfig.json',