Merge branch 'develop' into readme-git-command

.env.example

@@ -20,6 +20,7 @@ IMAGE_OPENAI_MODEL=             # Default: dall-e-3
 ETERNALAI_URL=
 ETERNALAI_MODEL=                # Default: "neuralmagic/Meta-Llama-3.1-405B-Instruct-quantized.w4a16"
 ETERNALAI_API_KEY=
+ETERNAL_AI_LOG_REQUEST=false #Default: false
 
 GROK_API_KEY=                   # GROK API Key
 GROQ_API_KEY=                   # Starts with gsk_
@@ -368,3 +369,7 @@ CRONOSZKEVM_PRIVATE_KEY=
 
 # Fuel Ecosystem (FuelVM)
 FUEL_WALLET_PRIVATE_KEY=
+
+# Tokenizer Settings
+TOKENIZER_MODEL=  # Specify the tokenizer model to be used.
+TOKENIZER_TYPE=   # Options: tiktoken (for OpenAI models) or auto (AutoTokenizer from Hugging Face for non-OpenAI models). Default: tiktoken.

.github/workflows/jsdoc-automation.yml

@@ -3,22 +3,32 @@ name: JSDoc Automation
 on:
   workflow_dispatch:
     inputs:
+      jsdoc:
+        description: 'Generate JSDoc comments (T/F)'
+        required: true
+        default: 'T'
+        type: string
+      readme:
+        description: 'Generate README documentation (T/F)'
+        required: true
+        default: 'T'
+        type: string
       pull_number:
-        description: 'Pull Request Number (if not provided, scans root_directory) - PR must be merged to develop branch'
+        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'
         required: false
         type: string
       root_directory:
         description: 'Only scans files in this directory (relative to repository root, e.g., packages/core/src)'
         required: true
-        default: 'packages/core/src/test_resources'
+        default: 'packages/plugin-near/'
         type: string
       excluded_directories:
         description: 'Directories to exclude from scanning (comma-separated, relative to root_directory)'
         required: true
         default: 'node_modules,dist,test'
         type: string
       reviewers:
-        description: 'Pull Request Reviewers (comma-separated GitHub usernames)'
+        description: 'Pull Request Reviewers (Must be collaborator on the repository) comma-separated GitHub usernames'
         required: true
         default: ''
         type: string
@@ -27,6 +37,11 @@ on:
         required: false
         default: 'develop'
         type: string
+      language:
+        description: 'Documentation language (e.g., English, Spanish, French)'
+        required: true
+        default: 'English'
+        type: string
 
 jobs:
   generate-docs:
@@ -45,7 +60,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: '23'
+          node-version: '20'
 
       - name: Install pnpm
         uses: pnpm/action-setup@v2
@@ -71,17 +86,19 @@ jobs:
         working-directory: scripts/jsdoc-automation
         run: pnpm install --no-frozen-lockfile
 
+      - name: Build TypeScript
+        working-directory: scripts/jsdoc-automation
+        run: pnpm build
+
       - name: Run documentation generator
         working-directory: scripts/jsdoc-automation
-        run: |
-          echo "Node version: $(node --version)"
-          echo "NPM version: $(npm --version)"
-          echo "Directory contents:"
-          ls -la
-          NODE_OPTIONS='--experimental-vm-modules --no-warnings' pnpm start
+        run: pnpm start
         env:
           INPUT_ROOT_DIRECTORY: ${{ inputs.root_directory }}
           INPUT_PULL_NUMBER: ${{ inputs.pull_number }}
           INPUT_EXCLUDED_DIRECTORIES: ${{ inputs.excluded_directories }}
           INPUT_REVIEWERS: ${{ inputs.reviewers }}
-          INPUT_BRANCH: ${{ inputs.branch }}
+          INPUT_BRANCH: ${{ inputs.branch }}
+          INPUT_LANGUAGE: ${{ inputs.language }}
+          INPUT_JSDOC: ${{ inputs.jsdoc }}
+          INPUT_README: ${{ inputs.readme }}

Dockerfile.docs

@@ -0,0 +1,58 @@
+# syntax=docker/dockerfile:1
+
+## Modified version of https://docusaurus.community/knowledge/deployment/docker/
+
+# Stage 1: Base image.
+## Start with a base image containing NodeJS so we can build Docusaurus.
+FROM node:23.3.0-slim AS base
+## Disable colour output from yarn to make logs easier to read.
+
+## https://pnpm.io/docker
+ENV PNPM_HOME="/pnpm"
+ENV PATH="$PNPM_HOME:$PATH"
+
+ENV FORCE_COLOR=0
+## Enable corepack.
+RUN corepack enable
+## Set the working directory to `/opt/docusaurus`.
+WORKDIR /opt/docusaurus
+
+## Required by docusaurus: [ERROR] Loading of version failed for version current
+RUN apt-get update && apt-get install -y git 
+
+FROM base AS dev
+## Set the working directory to `/opt/docusaurus`.
+WORKDIR /opt/docusaurus
+## Expose the port that Docusaurus will run on.
+EXPOSE 3000
+## Run the development server.
+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
+
+# Stage 2b: Production build mode.
+FROM base AS prod
+## Set the working directory to `/opt/docusaurus`.
+WORKDIR /opt/docusaurus
+
+COPY docs/package.json /opt/docusaurus/package.json
+COPY docs/package-lock.json /opt/docusaurus/package-lock.json
+
+## Install dependencies with `--immutable` to ensure reproducibility.
+RUN --mount=type=cache,id=pnpm,target=/pnpm/store pnpm install 
+
+## Copy over the source code.
+COPY docs/ /opt/docusaurus/
+COPY packages/ /opt/packages/
+
+## Required buy docusaurus [ERROR] Loading of version failed for version current
+COPY .git/ /opt/.git/
+
+# Build from sources
+RUN pnpm run build
+
+# Stage 3a: Serve with `docusaurus serve`.
+FROM prod AS serve
+## Expose the port that Docusaurus will run on.
+EXPOSE 3000
+## Run the production server.
+CMD ["npm", "run", "serve", "--", "--host", "0.0.0.0", "--no-open"]
+

README.md

@@ -12,7 +12,7 @@
 
 ## 🌍 README Translations
 
-[中文说明](./README_CN.md) | [日本語の説明](./README_JA.md) | [한국어 설명](./README_KOR.md) | [Français](./README_FR.md) | [Português](./README_PTBR.md) | [Türkçe](./README_TR.md) | [Русский](./README_RU.md) | [Español](./README_ES.md) | [Italiano](./README_IT.md) | [ไทย](./README_TH.md) | [Deutsch](./README_DE.md) | [Tiếng Việt](./README_VI.md) | [עִברִית](https://github.com/elizaos/Elisa/blob/main/README_HE.md) | [Tagalog](./README_TG.md) | [Polski](./README_PL.md) | [Arabic](./README_AR.md) | [Hungarian](./README_HU.md)
+[中文说明](./README_CN.md) | [日本語の説明](./README_JA.md) | [한국어 설명](./README_KOR.md) | [Français](./README_FR.md) | [Português](./README_PTBR.md) | [Türkçe](./README_TR.md) | [Русский](./README_RU.md) | [Español](./README_ES.md) | [Italiano](./README_IT.md) | [ไทย](./README_TH.md) | [Deutsch](./README_DE.md) | [Tiếng Việt](./README_VI.md) | [עִברִית](https://github.com/elizaos/Elisa/blob/main/README_HE.md) | [Tagalog](./README_TG.md) | [Polski](./README_PL.md) | [Arabic](./README_AR.md) | [Hungarian](./README_HU.md) | [Srpski](./README_RS.md)
 
 ## 🚩 Overview
 
@@ -149,4 +149,4 @@ pnpm install --include=optional sharp
 
 ## Star History
 
-[![Star History Chart](https://api.star-history.com/svg?repos=elizaos/eliza&type=Date)](https://star-history.com/#elizaos/eliza&Date)
+[![Star History Chart](https://api.star-history.com/svg?repos=elizaos/eliza&type=Date)](https://star-history.com/#elizaos/eliza&Date)

README_KOR.md

@@ -12,24 +12,20 @@
 
 ## ✨ 기능
 
-- 🛠 SNS 통합 지원: Discord, Twitter, Telegram을 모두 지원합니다.
-- 🔗 다양한 모델 호환: Llama, Grok, OpenAI, Anthropic 등 다양한 AI 모델을 지원합니다.
-- 👥 다중 에이전트 및 채팅방 지원: 여러 에이전트와 채팅방을 손쉽게 관리할 수 있습니다.
-- 📚 문서 처리 및 상호작용: 데이터를 손쉽게 추가하고 활용할 수 있는 기능을 제공합니다.
-- 💾 검색 가능한 메모리 및 문서 저장소: 데이터를 빠르고 간편하게 검색하고 액세스할 수 있습니다.
-- 🚀 높은 확장성: 사용자 정의 동작 및 클라이언트를 만들어 기능을 확장할 수 있습니다.
-- ☁️ 다양한 AI 모델 지원: Local Llama, OpenAI, Anthropic, Groq 등과 호환됩니다.
-- 📦 쉽게 시작하세요: 바로 작동하며 손쉽게 활용할 수 있습니다!
-
-## 비디오 튜토리얼
-
-[AI Agent Dev School](https://www.youtube.com/watch?v=ArptLpQiKfI&list=PLx5pnFXdPTRzWla0RaOxALTSTnVq53fKL)
-
-## 🎯 eliza로 어떤걸 만들 수 있을까요?
-
-- 🤖 챗봇 개발
-- 🕵 ️AI가 자율적으로 결과를 만들어줘요!
-- 📈 업무처리 자동화
+- 🛠 SNS 지원: 디스코드, 트위터, 텔레그램 연동 지원
+- 🔗 다양한 모델 지원 (Llama, Grok, OpenAI, Anthropic 등)
+- 👥 다중 지원: 다중 에이전트 및 채팅방 지원
+- 📚 높은 유연성: 데이터를 쉽게 추가하고 다양한 상호작용 가능
+- 💾 검색 지원: 데이터와 작업을 쉽게 찾아볼 수 있도록 검색 기능 지원
+- 🚀 높은 확장성: 사용자 정의 동작 및 클라이언트 생성 가능
+- ☁️ 다양한 AI 모델 지원: local Llama, OpenAI, Anthropic, Groq 등 다양한 AI 모델을 지원합니다
+- 📦 즐겁게 개발해 봐요!
+
+## 🎯 사용 사례
+
+- 🤖 챗봇
+- 🕵 ️자율 에이전트
+- 📈 자동화 프로세스
 - 🎮 비디오 게임 NPC
 - 🧠 트레이딩
 
@@ -41,28 +37,24 @@
 - [Node.js 23.3+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
 - [pnpm](https://pnpm.io/installation)
 
-> **Windows 사용자 참고:** [WSL 2](https://learn.microsoft.com/en-us/windows/wsl/install-manual)가 필요합니다.
+> **Windows 사용자 참고:** [WSL 2](https://learn.microsoft.com/en-us/windows/wsl/install-manual) 필요.
 
 ### Starter 사용 (권장)
 
 ```bash
 git clone https://github.com/elizaos/eliza-starter.git
-cd eliza-starter
+
 cp .env.example .env
-pnpm i && pnpm build && pnpm start
-```
-에이전트가 실행되면 마지막에 "pnpm start:client"를 실행하라는 메시지가 표시됩니다. 
-다른 터미널을 열고 같은 디렉토리로 이동한 뒤 아래 명령어를 실행하세요. 표시된 URL을 열어 에이전트와 대화하세요.
-```bash
-pnpm start:client
+
+pnpm i && pnpm start
 ```
 
-[문서](https://elizaos.github.io/eliza/)를 참고하여 Eliza를 커스터마이징하는 방법을 배워보세요.
+[문서](https://elizaos.github.io/eliza/)를 참고하여 Eliza를 커스마이징 방법을 확인하세요.
 
-### Eliza를 수동으로 실행하기 (경험자에게만 권장)
+### 수동으로 실행 (사용법을 알고 있는 경우에만 권장)
 
 ```bash
-# 리포지토리 클론
+# 저장소 복사
 git clone https://github.com/elizaos/eliza.git
 
 # 최신 릴리스로 체크아웃
@@ -115,23 +107,23 @@ pnpm clean
 
 #### 추가 요구 사항
 
-시작할 때 오류가 발생하면 Sharp를 설치해야 할 수도 있습니다. 아래 명령어를 실행하여 설치하세요:
+시작 시 에러가 발생하면 Sharp를 설치해야 할 수 있습니다. 아래 명령어를 사용하여 설치하세요:
 
 ```
 pnpm install --include=optional sharp
 ```
 
 ### 커뮤니티 & 문의
 
-- [Github Issues](https://github.com/elizaos/eliza/issues). liza 사용 중 발견된 버그 보고 및 기능 제안에 적합합니다.
-- [Discord](https://discord.gg/ai16z). 애플리케이션 공유 및 커뮤니티와의 소통에 적합합니다.
+- [Github Issues](https://github.com/elizaos/eliza/issues). 용도: Eliza 사용 중 발견된 버그 리포트, 기능 제안.
+- [Discord](https://discord.gg/ai16z). 용도: 애플리케이션 공유 및 커뮤니티 활동.
 
-## 컨트리뷰터
+## 기여자
 
 <a href="https://github.com/elizaos/eliza/graphs/contributors">
   <img src="https://contrib.rocks/image?repo=elizaos/eliza" />
 </a>
 
 ## 스타 기록
 
-[![Star History Chart](https://api.star-history.com/svg?repos=elizaos/eliza&type=Date)](https://star-history.com/#elizaos/eliza&Date)
+[![Star History Chart](https://api.star-history.com/svg?repos=elizaos/eliza&type=Date)](https://star-history.com/#elizaos/eliza&Date)