Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Agentic Eliza Plugin Documenter - Multilingual (e.g., English, Spanish, French) #1675

Merged
merged 37 commits into from
Jan 4, 2025

Conversation

Ed-Marcavage
Copy link
Contributor

@Ed-Marcavage Ed-Marcavage commented Jan 2, 2025

Relates to:

Risks

  • Minimal risk, malformed JSDoc has been mitigated. Only risk is LLM hallucinates and writes incorrect documentation.
✓ JSDoc comment in portfolioProvider.ts was fixed using regex patterns
✓ JSDoc comment in token.ts was fixed using regex patterns
✓ JSDoc comment in trustScoreProvider.ts was fixed using regex patterns

Background

What does this PR do?

  • Supports Full plugin documentation: Ovierview, Install, Confi, Usage, API Reference, Todo explanations, Actions, Evals, Providers + JSDoc, and troubleshooting & Multilingual (e.g., English, Spanish, French)
  • Builds off of feat: Add agentic JSDoc generation  #1343
  • Refactors to use ts up
  • adds JSDoc validation: JSDoc is inserted -> ensures it compiles -> if not try regex fix -> recall LLM as last resort
  • Adds clarity around GH action inputs

What kind of change is this?

  • Improvements

Documentation changes needed?

My changes do not require a change to the project documentation. - Its created agenticly

Testing

Where should a reviewer start?

  • src/index.ts

Detailed testing steps

  • Ensure JSDoc & Readme match the plugin being scanned

Deploy Notes

  • Set GH_PAT & OPENAI_API_KEY in github actions as secret env variables

Discord username

  • 0xbuildinpublic

Ed-Marcavage and others added 30 commits December 30, 2024 21:34
* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation
* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation (#5)

* feat: add support for agentic plugin documentation

* Feature/full plugin docs (#7)

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation
* chore: remove .env

* git ignore has .cursorrules

* Revert "lint: fix EmbeddingProvider already defined error (via claude)"

This reverts commit bbbf325.

* fix(client-twitter): tighten engagement criteria and raise quality thresholds

* Update README.md

* Update README_CN - Model Configuration

The original model configuration guide is misleading, it tells readers to configure model provider by change the `XAI_MODEL` parameters.

But this is for the XAI configurations, i update the description completely with the right configuration steps.

* Added Polish Readme file

* Fixed polish's readme typo's

* Rename Readme_PL.md to README_PL.md

* feat: fix chat client to autoscroll

* chore: update changelog

* feat: improve messages

Improve message so criteria is displayed

* fix number prefixed username, add X brand in messaging

* refactor: reorganize imports in video service

* fix: improve clarity and grammar in pull request template

* fix tg markdown issue.

* fix: update jsdoc automation workflow

* fix: update jsdoc automation workflow

* docs: Add JSDoc documentation to constants.ts

* docs: Add JSDoc documentation to createRuntime.ts

* docs: Add JSDoc documentation to testSetup.ts

* docs: Add JSDoc documentation to types.ts

* docs: Add JSDoc documentation to constants.ts

* docs: Add JSDoc documentation to createRuntime.ts

* docs: Add JSDoc documentation to testSetup.ts

* docs: Add JSDoc documentation to types.ts

* feat: Twitter spaces integration

* Adding pnpm-lock.yaml

* add character file script to make system prompt and templates easier to add to existing character files or generate a new one

* feat: add theme toggle functionality with dark and light mode support

- Imported ThemeToggle component in AppSidebar
- Added ThemeToggle to SidebarFooter in AppSidebar
- Initialized theme based on localStorage and system preferences in main.tsx to support dark and light modes

* docs: Add "What Did You Get Done This Week? 7" notes

* Adding back comments and documentation

* add TEE plugin-env support

* fix

* fix

* fix: init 768 dimension in database for gaianet

* chore: parse files through prettier

* Update README.md

* Add files via upload

* feat: add optional TRANSCRIPTION_PROVIDER setting with fallback logic, moving twitter spaces plugins to Eliza repo

* Updates for web search and timeout

* Cleanup on packages/client-twitter/src/plugins/SttTtsPlugin.ts

* Update agents.md

Minor update to correct "should"

* add an client-direct endpoint to get memories by agentid and roomid

* docs: fix Contributing Guide

* feat: add docs for image generation plugin

* fix: fix the image redirection

* update volcengine model

* feat: Add Spanish Translation for Documentation README

* added README files to all plugins

* use tavily sdk

* file updates

* tweak of evm transfer template

* refactor(plugin-conflux): output detailed invalid content

* add experimental telemetry model option

* chore: console -> elizaLogger

* chore: pnpm lock file

* chore: fix conflicts

* chore: add readme

* fix: set publishedDate to optional as stated by the docs.

* chore: move tavily package to the core

* chore: pnpm lock file

* feat: add error handling for TAVILY_API_KEY key

* chore: remove conflicting files

* chore: README files

* chore: Update local-development.md

* fix continue double responses

* fix google api key

* feat: include priority to plugin-tee build

* chore: remove build cache with clean command

* chore: changes to settings

* fix: add @tavily/core to external libs (almost took my life)

* chore: remove logs

* chore: console -> elizaLogger

* add plugins to the key components section of the faq

during a recent discussion on discord it was not clear to some folks the conceptual difference between clients and plugins. this just adds a bit more high level info up top on the FAQ for future creators.

* re-build fx

* Fix double spaced tweets in Post.ts

Currently, despite the prompting stating to use "\\n\\n (double spaces" between statements the tweets always output new statements with just a single newline, making tweets look blocky. 

For example, tweets previous would look like (despite the prompt): 
"Dobby is so excited to start this new year, full of possibilities and chances to make a difference!
Dobby has big plans to help his dear friends and make the wizarding world an even brighter place."

This ensures the double spaces requested in prompting is applied to the tweets with the tweets now looking like: 
"Dobby must remind all friends to be cautious of dark magic lurking in the shadows.

Dobby's heart aches at the thought of anyone falling prey to its deceitful powers."

This allows agents to tweet better-formatted posts that ease visilibty.

* add TranscriptionProvider

* select transcription provider based on character setting

* clean code

* fix evm deps

* fix bad merge

* remove claude changes

* corrected path for image upload

* Add README_AR.md

Add Arabic language for readme.

* chore: update viem dependency version in plugin-evm and plugin-goat

* Update README.md

add Arabic language reference

* Update package.json

* Update package.json

* fix: remove unwanted gitignore

* chore: add enable web search variable

* chore: pnpm lock file

* fix: import web search plugin only on when enabled

* fix: lockfile

* testing

* update

* Added Hungarian README

* update clean.sh to include deleting lock file to really reset the repo

* update integreation test

* run on pull request not pull request target

* update to use pnpm command

* trigger re-run of workflows

* fix

* revert

* actually need to revert

* Fix bug in plugin-bootstrap/src/evaluators/facts.ts

{{user1}} should be {{user2}} :

-------
in factEvaluator, in the examples template,

{{user1}} should be {{user2}} instead

                {
                    user: "{{user1}}",
                    content: { text: "Which city?" },
                },
                {
                    user: "{{user2}}",
                    content: { text: "Oakland" },
                },
                {
                    user: "{{user1}}",
                    content: {
                        text: "Oh, I've never been there, but I know it's in California",
                    },
                }

* standardize viem dependency so project builds now

* missing depdencies

* revert to target due to https://github.com/ai16z/eliza/pull/993/files#r1883351009

* remove submodule

* Solve Issue 1643, imageDescriptionService not working with other providers than OpenAI

* Update schema.sql

There is an extra semicolon that causes a syntax error when trying to upload the schema to supabase.

* Solve Issue 1643, imageDescriptionService not working with other providers than OpenAI

* Seperated imageModelProvider and imageVisionModelProvider for ImageDescriptionService

* modelVisionProvider Added to IagentRuntime interface type.ts

* Feature/full plugin docs (#52)

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation (#5)

* feat: add support for agentic plugin documentation

* Feature/full plugin docs (#7)

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation

---------

Co-authored-by: J. Brandon Johnson <[email protected]>
Co-authored-by: E.FU <[email protected]>
Co-authored-by: odilitime <[email protected]>
Co-authored-by: SK1989sL <[email protected]>
Co-authored-by: JOMOKING <[email protected]>
Co-authored-by: Judasz <[email protected]>
Co-authored-by: yanushevitz <[email protected]>
Co-authored-by: Monil Patel <[email protected]>
Co-authored-by: Matt Gunnin <[email protected]>
Co-authored-by: azep-ninja <[email protected]>
Co-authored-by: jin <[email protected]>
Co-authored-by: Shakker Nerd <[email protected]>
Co-authored-by: slkzgm <[email protected]>
Co-authored-by: HashWarlock <[email protected]>
Co-authored-by: zkfriendly <[email protected]>
Co-authored-by: Phlo <[email protected]>
Co-authored-by: Shakker Nerd <[email protected]>
Co-authored-by: Sam <[email protected]>
Co-authored-by: csh <[email protected]>
Co-authored-by: tomguluson92 <[email protected]>
Co-authored-by: Chanddeep Madaan <[email protected]>
Co-authored-by: Yorke E. Rhodes III <[email protected]>
Co-authored-by: treppers <[email protected]>
Co-authored-by: twilwa <[email protected]>
Co-authored-by: 0xFloyd <[email protected]>
Co-authored-by: chandiniv1 <[email protected]>
Co-authored-by: Sebastián Salazar Solano <[email protected]>
Co-authored-by: zhourunlai <[email protected]>
Co-authored-by: CheddarQueso <[email protected]>
Co-authored-by: zkvm <[email protected]>
Co-authored-by: bendanzhentan <[email protected]>
Co-authored-by: Ninja Dev (QI) <[email protected]>
Co-authored-by: Cole Gillespie <[email protected]>
Co-authored-by: Suicidal Goofy <[email protected]>
Co-authored-by: Ting Chien Meng <[email protected]>
Co-authored-by: Shaw <[email protected]>
Co-authored-by: ShreyGanatra <[email protected]>
Co-authored-by: Mariem Mohamed <[email protected]>
Co-authored-by: Arthera Node <[email protected]>
Co-authored-by: mdominikd <[email protected]>
Co-authored-by: metakai1 <[email protected]>
Co-authored-by: nusk0 <[email protected]>
Co-authored-by: 0xRider <[email protected]>
Co-authored-by: Your Name <[email protected]>
* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation (#5)

* feat: add support for agentic plugin documentation

* Feature/full plugin docs (#7)

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation
* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation (#5)

* feat: add support for agentic plugin documentation

* Feature/full plugin docs (#7)

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation
* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation (#5)

* feat: add support for agentic plugin documentation

* Feature/full plugin docs (#7)

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation

* feat: add support for agentic plugin documentation
Copy link
Collaborator

@madjin madjin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@madjin madjin merged commit 3b36e79 into elizaOS:develop Jan 4, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants