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

chore: Document Missing Plugin Documentation and Examples #1200

Open
20 tasks
madjin opened this issue Dec 18, 2024 · 10 comments
Open
20 tasks

chore: Document Missing Plugin Documentation and Examples #1200

madjin opened this issue Dec 18, 2024 · 10 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@madjin
Copy link
Collaborator

madjin commented Dec 18, 2024

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:

  • plugin-0g - File storage plugin
  • plugin-aptos - Aptos blockchain integration
  • plugin-conflux - Conflux blockchain integration
  • plugin-echochambers - Echo chamber client
  • plugin-flow - Flow blockchain integration
  • plugin-goat - GOAT functionality
  • plugin-icp - Internet Computer integration
  • plugin-image-generation - Image generation capabilities
  • plugin-intiface - Intiface integration
  • plugin-multiversx - MultiversX blockchain
  • plugin-near - NEAR Protocol integration
  • plugin-nft-generation - NFT creation functionality
  • plugin-story - Story/IP management
  • plugin-sui - Sui blockchain integration
  • plugin-ton - TON blockchain integration
  • plugin-trustdb - Trust database functionality
  • plugin-video-generation - Video generation features
  • plugin-web-search - Web search capabilities
  • plugin-whatsapp - WhatsApp integration
  • plugin-zksync-era - zkSync Era integration

Proposed Documentation Structure
For each plugin, we need:

  1. Overview and purpose
  2. Installation instructions
  3. Configuration requirements
  4. Usage examples
  5. API reference
  6. Common issues/troubleshooting

Additional Missing Docs

  • Examples folder documentation
  • Testing guide expansion
  • Plugin development guide
  • Security best practices
  • Performance optimization guide

Value Add
This documentation will:

  • Improve developer onboarding
  • Reduce support questions
  • Enable faster plugin adoption
  • Help maintain code quality
@madjin madjin added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 18, 2024
@ileana-pr
Copy link
Contributor

I can help with this. Will update.

@ileana-pr
Copy link
Contributor

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.

@0xbuild-oss
Copy link

Attempting to create an automated solution for this @ileana-pr would love to collab, basically whenever a new plugin is added:

Auto:

  1. Overview and purpose
  2. Installation instructions
  3. Configuration requirements
  4. Usage examples
  5. API reference
  6. Common issues/troubleshooting

@0xbuild-oss
Copy link

Status can again be checked here, will be moved into forked Eliza after POC built out:
https://github.com/AudixAI/plugin-audix

@madjin
Copy link
Collaborator Author

madjin commented Dec 26, 2024

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

@madjin
Copy link
Collaborator Author

madjin commented Dec 26, 2024

Attempting to create an automated solution for this @ileana-pr would love to collab, basically whenever a new plugin is added:

Auto:

  1. Overview and purpose
  2. Installation instructions
  3. Configuration requirements
  4. Usage examples
  5. API reference
  6. Common issues/troubleshooting
  1. TODO

Lets add a README file in each plugin folder for portability, can later migrate those to the docs.

@0xbuild-oss
Copy link

Great idea and easy addition, on it.

@ileana-pr
Copy link
Contributor

@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.

@ileana-pr
Copy link
Contributor

@madjin @0xbuild-oss submitted pr to add README.md files to plugins.

#1601

@shakkernerd
Copy link
Member

@ileana-pr Great work! 🔥

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants