Commit graph

2 commits

Author SHA1 Message Date
Nick Misasi
b673343a01 docs(11-03): add server integration and troubleshooting documentation
Update Python plugin documentation with:
- Server Integration section explaining how Python plugins work
- Feature parity table comparing Go and Python plugins
- Known differences (startup time, memory overhead, ServeMetrics)
- Comprehensive Troubleshooting section covering:
  - Plugin startup failures
  - Hooks not being called
  - HTTP request failures
  - API call failures
  - Performance issues
  - Debugging tips

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-19 22:39:03 -05:00
Nick Misasi
1e2db90e54 docs(10-03): add comprehensive Python plugin developer documentation
Create detailed documentation covering all aspects of Python plugin
development:

1. Introduction
   - What Python plugins enable
   - When to use Python vs Go plugins
   - Performance considerations

2. Getting Started
   - Prerequisites and project setup
   - Plugin structure and entry point
   - Basic plugin example

3. Plugin Manifest
   - server.runtime: "python" field
   - server.python_version field
   - server.python configuration block
   - Field reference table

4. SDK Reference
   - Plugin base class
   - Hook decorator (@hook)
   - API client access (self.api)
   - Logger access (self.logger)

5. Hook Reference
   - Lifecycle hooks (OnActivate, OnDeactivate, OnConfigurationChange)
   - Message hooks with allow/reject/modify patterns
   - User, channel, team hooks
   - Command hook example

6. API Reference
   - Method categories overview
   - Error handling with exception hierarchy
   - Async client usage

7. ServeHTTP
   - HTTP request handling
   - Request/response format

8. Best Practices
   - Error handling patterns
   - Logging guidelines
   - Testing strategies
   - Resource management
   - Configuration access

References the hello_python example plugin created in 10-01.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-19 15:45:24 -05:00