Skip to content

Commit a822a0e

Browse files
shakkernerdshakkernerd
authored
Merge branch 'develop' into fix/line-break-formatting-in-chat
2 parents 3290c0c + ee79ef2 commit a822a0e

21 files changed

+2808
-107
lines changed

‎.github/workflows/jsdoc-automation.yml

+28-11
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,32 @@ name: JSDoc Automation
33
on:
44
workflow_dispatch:
55
inputs:
6+
jsdoc:
7+
description: 'Generate JSDoc comments (T/F)'
8+
required: true
9+
default: 'T'
10+
type: string
11+
readme:
12+
description: 'Generate README documentation (T/F)'
13+
required: true
14+
default: 'T'
15+
type: string
616
pull_number:
7-
description: 'Pull Request Number (if not provided, scans root_directory) - PR must be merged to develop branch'
17+
description: 'Pull Request Number (if not provided, scans root_directory) - PR must be merged to develop branch. DONT provide if `README documentation` is T from above'
818
required: false
919
type: string
1020
root_directory:
1121
description: 'Only scans files in this directory (relative to repository root, e.g., packages/core/src)'
1222
required: true
13-
default: 'packages/core/src/test_resources'
23+
default: 'packages/plugin-near/'
1424
type: string
1525
excluded_directories:
1626
description: 'Directories to exclude from scanning (comma-separated, relative to root_directory)'
1727
required: true
1828
default: 'node_modules,dist,test'
1929
type: string
2030
reviewers:
21-
description: 'Pull Request Reviewers (comma-separated GitHub usernames)'
31+
description: 'Pull Request Reviewers (Must be collaborator on the repository) comma-separated GitHub usernames'
2232
required: true
2333
default: ''
2434
type: string
@@ -27,6 +37,11 @@ on:
2737
required: false
2838
default: 'develop'
2939
type: string
40+
language:
41+
description: 'Documentation language (e.g., English, Spanish, French)'
42+
required: true
43+
default: 'English'
44+
type: string
3045

3146
jobs:
3247
generate-docs:
@@ -45,7 +60,7 @@ jobs:
4560
- name: Setup Node.js
4661
uses: actions/setup-node@v4
4762
with:
48-
node-version: '23'
63+
node-version: '20'
4964

5065
- name: Install pnpm
5166
uses: pnpm/action-setup@v2
@@ -71,17 +86,19 @@ jobs:
7186
working-directory: scripts/jsdoc-automation
7287
run: pnpm install --no-frozen-lockfile
7388

89+
- name: Build TypeScript
90+
working-directory: scripts/jsdoc-automation
91+
run: pnpm build
92+
7493
- name: Run documentation generator
7594
working-directory: scripts/jsdoc-automation
76-
run: |
77-
echo "Node version: $(node --version)"
78-
echo "NPM version: $(npm --version)"
79-
echo "Directory contents:"
80-
ls -la
81-
NODE_OPTIONS='--experimental-vm-modules --no-warnings' pnpm start
95+
run: pnpm start
8296
env:
8397
INPUT_ROOT_DIRECTORY: ${{ inputs.root_directory }}
8498
INPUT_PULL_NUMBER: ${{ inputs.pull_number }}
8599
INPUT_EXCLUDED_DIRECTORIES: ${{ inputs.excluded_directories }}
86100
INPUT_REVIEWERS: ${{ inputs.reviewers }}
87-
INPUT_BRANCH: ${{ inputs.branch }}
101+
INPUT_BRANCH: ${{ inputs.branch }}
102+
INPUT_LANGUAGE: ${{ inputs.language }}
103+
INPUT_JSDOC: ${{ inputs.jsdoc }}
104+
INPUT_README: ${{ inputs.readme }}

‎Dockerfile.docs

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# syntax=docker/dockerfile:1
2+
3+
## Modified version of https://docusaurus.community/knowledge/deployment/docker/
4+
5+
# Stage 1: Base image.
6+
## Start with a base image containing NodeJS so we can build Docusaurus.
7+
FROM node:23.3.0-slim AS base
8+
## Disable colour output from yarn to make logs easier to read.
9+
10+
## https://pnpm.io/docker
11+
ENV PNPM_HOME="/pnpm"
12+
ENV PATH="$PNPM_HOME:$PATH"
13+
14+
ENV FORCE_COLOR=0
15+
## Enable corepack.
16+
RUN corepack enable
17+
## Set the working directory to `/opt/docusaurus`.
18+
WORKDIR /opt/docusaurus
19+
20+
## Required by docusaurus: [ERROR] Loading of version failed for version current
21+
RUN apt-get update && apt-get install -y git
22+
23+
FROM base AS dev
24+
## Set the working directory to `/opt/docusaurus`.
25+
WORKDIR /opt/docusaurus
26+
## Expose the port that Docusaurus will run on.
27+
EXPOSE 3000
28+
## Run the development server.
29+
CMD [ -d "node_modules" ] && npm run start -- --host 0.0.0.0 --poll 1000 || pnpm install && pnpm run start -- --host 0.0.0.0 --poll 1000
30+
31+
# Stage 2b: Production build mode.
32+
FROM base AS prod
33+
## Set the working directory to `/opt/docusaurus`.
34+
WORKDIR /opt/docusaurus
35+
36+
COPY docs/package.json /opt/docusaurus/package.json
37+
COPY docs/package-lock.json /opt/docusaurus/package-lock.json
38+
39+
## Install dependencies with `--immutable` to ensure reproducibility.
40+
RUN --mount=type=cache,id=pnpm,target=/pnpm/store pnpm install
41+
42+
## Copy over the source code.
43+
COPY docs/ /opt/docusaurus/
44+
COPY packages/ /opt/packages/
45+
46+
## Required buy docusaurus [ERROR] Loading of version failed for version current
47+
COPY .git/ /opt/.git/
48+
49+
# Build from sources
50+
RUN pnpm run build
51+
52+
# Stage 3a: Serve with `docusaurus serve`.
53+
FROM prod AS serve
54+
## Expose the port that Docusaurus will run on.
55+
EXPOSE 3000
56+
## Run the production server.
57+
CMD ["npm", "run", "serve", "--", "--host", "0.0.0.0", "--no-open"]
58+

‎docker-compose-docs.yaml

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
services:
2+
docs:
3+
build:
4+
dockerfile: Dockerfile.docs
5+
context: .
6+
target: serve
7+
ports:
8+
- 3000:3000
9+

‎docs/README.md

+10
Original file line numberDiff line numberDiff line change
@@ -179,3 +179,13 @@ Tests are written using Jest and can be found in `src/**/*.test.ts` files. The t
179179
- Run tests in sequence (--runInBand)
180180

181181
To create new tests, add a `.test.ts` file adjacent to the code you're testing.
182+
183+
## Docs Updates
184+
185+
Please make sure to vetify if the documentation provided is correct. In order to do so, please run the docs service.
186+
187+
```console
188+
docker compose -f docker-compose-docs.yaml up --build
189+
```
190+
191+
The docusaurus server will get started and you can verify it locally at https://localhost:3000/eliza.

‎docs/docs/packages/plugins.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -610,12 +610,12 @@ The Fuel plugin provides an interface to the Fuel Ignition blockchain.
610610
**Actions:**
611611

612612
1. `TRANSFER_FUEL_ETH` - Transfer ETH to a given Fuel address. - **Inputs**: - `toAddress` (string): The Fuel address to transfer ETH to. - `amount` (string): The amount of ETH to transfer. - **Outputs**: Confirmation message with transaction details. - **Example**:
613-
`json
614-
{
613+
```json
614+
{
615615
"toAddress": "0x8F8afB12402C9a4bD9678Bec363E51360142f8443FB171655eEd55dB298828D1",
616616
"amount": "0.00001"
617-
}
618-
`
617+
}
618+
```
619619
**Setup and Configuration:**
620620

621621
1. **Configure the Plugin**

‎docs/package.json

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
"name": "eliza-docs",
33
"version": "0.1.7-alpha.2",
44
"private": true,
5+
"packageManager": "pnpm@9.4.0",
56
"scripts": {
67
"docusaurus": "docusaurus",
78
"start": "docusaurus start --no-open",
@@ -21,9 +22,11 @@
2122
"@docusaurus/plugin-ideal-image": "3.6.3",
2223
"@docusaurus/preset-classic": "3.6.3",
2324
"@docusaurus/theme-mermaid": "3.6.3",
25+
"@docusaurus/theme-common": "3.6.3",
2426
"@mdx-js/react": "3.0.1",
2527
"clsx": "2.1.1",
2628
"docusaurus-lunr-search": "3.5.0",
29+
"lunr": "2.3.9",
2730
"dotenv": "^16.4.7",
2831
"prism-react-renderer": "2.3.1",
2932
"react": "18.3.1",

‎scripts/jsdoc-automation/package.json

+9-5
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,13 @@
33
"name": "plugin-audix",
44
"version": "1.0.0",
55
"description": "",
6-
"main": "index.ts",
6+
"main": "dist/index.js",
7+
"module": "dist/index.mjs",
8+
"types": "dist/index.d.ts",
79
"scripts": {
8-
"start": "NODE_OPTIONS='--loader ts-node/esm' node src/index.ts",
9-
"test": "echo \"Error: no test specified\" && exit 1",
10+
"build": "tsup",
11+
"dev": "tsup --watch",
12+
"start": "node dist/index.js",
1013
"clean": "rm -rf node_modules dist"
1114
},
1215
"keywords": [],
@@ -16,15 +19,16 @@
1619
"@langchain/openai": "^0.3.16",
1720
"@octokit/rest": "^21.0.2",
1821
"@types/node": "^20.11.0",
19-
"dotenv": "^16.4.7",
20-
"langchain": "^0.3.7",
2122
"@typescript-eslint/parser": "6.18.1",
2223
"@typescript-eslint/types": "6.18.1",
2324
"@typescript-eslint/typescript-estree": "6.18.1",
25+
"dotenv": "^16.4.7",
26+
"langchain": "^0.3.7",
2427
"yaml": "^2.3.4"
2528
},
2629
"devDependencies": {
2730
"ts-node": "^10.9.2",
31+
"tsup": "^8.3.5",
2832
"typescript": "5.3.3"
2933
}
3034
}

0 commit comments

Comments
 (0)