-
Notifications
You must be signed in to change notification settings - Fork 2.5k
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
chore: Document Missing Plugin Documentation and Examples #1200
Comments
I can help with this. Will update. |
PR update: docs: sample plugin documentation #1385 Created documentation for 0G plugin, uploaded for review/comments. If this is good will create for all plugins. |
Attempting to create an automated solution for this @ileana-pr would love to collab, basically whenever a new plugin is added: Auto:
|
Status can again be checked here, will be moved into forked Eliza after POC built out: |
I noticed that TODO comments are almost exclusively all plugin related. Perhaps we can generate a README section for TODO if such comments are detected in the code: #1223 |
Lets add a README file in each plugin folder for portability, can later migrate those to the docs. |
Great idea and easy addition, on it. |
@0xbuild-oss back from xmas break. Happy to help with automated solution. I see the pr #1385 was merged so in the meantime I will keep creating README for each plugin. Will update. |
@madjin @0xbuild-oss submitted pr to add README.md files to plugins. |
@ileana-pr Great work! 🔥 |
Overview
Several plugins in the Eliza framework lack comprehensive documentation. This makes it harder for new developers to understand and utilize these components.
Missing Plugin Documentation:
Proposed Documentation Structure
For each plugin, we need:
Additional Missing Docs
Value Add
This documentation will:
The text was updated successfully, but these errors were encountered: