Skip to content
This repository was archived by the owner on Apr 15, 2026. It is now read-only.

DOCUMENTATION_INDEX.md

Latest commit

 

History

History
79 lines (61 loc) · 3.14 KB

DOCUMENTATION_INDEX.md

File metadata and controls

79 lines (61 loc) · 3.14 KB
Raw

ELITEA/Pylon Plugin Documentation Index

This repository contains a complete set of documentation for creating ELITEA/Pylon integration plugins. Here's your navigation guide:

🎯 Choose Your Starting Point

🚀 Quick Start (5 minutes)

  • Quick Start Template - Minimal working example to get started immediately
  • Template Script: Run python setup_template.py for guided setup

📚 Learn Step-by-Step (30 minutes)

  • Step-by-Step Guide - Complete walkthrough building an image processing plugin from scratch
  • Perfect for understanding the architecture and concepts

🔍 Find Specific Patterns

  • Integration Patterns - Common patterns for different tool types:
    • Python libraries (PIL, pandas, scikit-learn)
    • CLI tools (FFmpeg, ImageMagick, Pandoc)
    • Node.js tools (Puppeteer, Express)
    • REST APIs and databases
    • Machine learning models

📖 Complete Reference

🛠️ Template Usage

For New Plugin Development

  1. Template README - Use this repository as a template
  2. Setup Script: python setup_template.py - Interactive plugin generation
  3. Testing: python test_plugin.py - Comprehensive test suite

For Creating Template Repositories

🎯 Real-World Example

This repository itself contains a complete integration template that demonstrates:

  • External binary management (Node.js)
  • Package installation (npm packages)
  • Environment setup
  • Temporary workspace management
  • Error handling patterns

Study the main README and the actual plugin files for a production-ready example.

📋 Documentation Map

📁 ELITEA/Pylon Plugin Documentation
├── 🚀 Quick Start
│   ├── Quick Start Template (minimal example)
│   └── Template Setup Script (python setup_template.py)
├── 📚 Learning
│   ├── Step-by-Step Guide (complete tutorial)
│   └── Integration Patterns (tool-specific patterns)
├── 📖 Reference
│   ├── Integration Guide (comprehensive reference)
│   └── API Specification (technical details)
├── 🛠️ Template Tools
│   ├── Template README (using as template)
│   ├── Template Setup Instructions (creating templates)
│   └── Test Suite (python test_plugin.py)
└── 🎯 Real Example
    └── Integration Template (this repository)

🆘 Need Help?

  1. Getting started: Follow the Quick Start Template
  2. Understanding concepts: Read the Step-by-Step Guide
  3. Finding patterns: Check Integration Patterns
  4. Technical details: Reference the Integration Guide
  5. Real example: Study this repository's template implementation

Happy plugin building! 🚀