set shell to bash and update readme

langchain-ai · Nov 6, 2023 · e89df62 · e89df62
1 parent ea17cd4
commit e89df62
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 1 deletion.
diff --git a/.github/workflows/test-exports.yml b/.github/workflows/test-exports.yml
@@ -35,6 +35,7 @@ jobs:
         run: yarn install --immutable
       - name: Build
         run: yarn workspace langchain build
+        shell: bash
         env:
           SKIP_API_DOCS: true
 
@@ -54,6 +55,7 @@ jobs:
         run: yarn install --immutable
       - name: Build
         run: yarn workspace langchain build
+        shell: bash
         env:
           SKIP_API_DOCS: true
 
@@ -73,6 +75,7 @@ jobs:
         run: yarn install --immutable
       - name: Build
         run: yarn workspace langchain build
+        shell: bash
         env:
           SKIP_API_DOCS: true
 
@@ -92,6 +95,7 @@ jobs:
         run: yarn install --immutable
       - name: Build
         run: yarn workspace langchain build
+        shell: bash
         env:
           SKIP_API_DOCS: true
 
@@ -111,6 +115,7 @@ jobs:
         run: yarn install --immutable
       - name: Build
         run: yarn workspace langchain build
+        shell: bash
         env:
           SKIP_API_DOCS: true
 
@@ -130,6 +135,7 @@ jobs:
         run: yarn install --immutable
       - name: Build
         run: yarn workspace langchain build
+        shell: bash
         env:
           SKIP_API_DOCS: true
 
@@ -149,6 +155,7 @@ jobs:
         run: yarn install --immutable
       - name: Build
         run: yarn workspace langchain build
+        shell: bash
         env:
           SKIP_API_DOCS: true
 

diff --git a/api-docs/README.md b/api-docs/README.md
@@ -1 +1,11 @@
-# Autogeneratd API documentation for LangChainJS
+# Autogeneratd API documentation for LangChainJS
+
+Do not edit the contents of this directory directly.
+
+## Usage
+
+To build the API refs run `yarn build` from the root of this directory, then `yarn dev` or `yarn start` to serve the docs locally.
+This app uses [Typedoc](https://typedoc.org/) to generate API references from the source code. The generated HTML is then placed inside the `/public` directory, which is served by [Next.js](https://nextjs.org/).
+There is a default redirect when requests are made to `/` which redirects to `/index.html`.
+
+The API references are gitignored by default, so they will not be committed to the repo.