Skip to content

support.mdx

Latest commit

 

History

History
390 lines (255 loc) · 9.84 KB

support.mdx

File metadata and controls

390 lines (255 loc) · 9.84 KB

Support & Community

Get help, connect with other users, and stay updated with OmniDaemon.

💬 Community Support (Free)

GitHub Discussions

Best for: General questions, sharing ideas, community help

Visit Discussions →

Categories:

  • Q&A - Ask questions, get answers from the community
  • Show and Tell - Share your OmniDaemon projects
  • Ideas - Suggest new features or improvements
  • General - Everything else

Tips for getting help:

  • ✅ Search existing discussions first
  • ✅ Provide code examples
  • ✅ Include error messages/tracebacks
  • ✅ Mention your environment (Python version, OS)

GitHub Issues

Best for: Bug reports, feature requests

Report Bug →

When to use:

  • Found a bug? Report it!
  • Missing a feature? Request it!
  • Have a concrete improvement? Suggest it!

Not for:

  • General "how-to" questions (use Discussions)
  • Support requests (use Discussions)
  • Debugging your code (use Discussions)

Discord (Coming Soon!)

Best for: Real-time chat, quick questions

Channels:

  • #general - General discussion
  • #help - Get help from community
  • #showcase - Show off your projects
  • #announcements - Updates and releases

📖 Self-Service Resources

Documentation

Official Documentation: https://abiorh001.github.io/OmniDaemon/

Key Sections:

README

Project README: https://github.com/omnirexflora-labs/OmniDaemon/blob/main/README.md

The README contains:

  • Installation instructions
  • Quick start guide
  • Core concepts overview
  • Configuration examples
  • Common patterns
  • Troubleshooting tips

Examples

Working Code Examples: https://github.com/omnirexflora-labs/OmniDaemon/tree/main/examples

Available examples:

  • OmniCore Agent - MCP tools, memory routing
  • Google ADK Agent - Gemini integration
  • Publisher - Publishing events
  • Multi-Agent - Running multiple agents

🎓 Learning Resources

Tutorials (Coming Soon)

  • Getting started with OmniDaemon
  • Building your first AI agent
  • Multi-agent orchestration
  • Production deployment guide

Blog Posts (Coming Soon)

Stay tuned for deep dives on:

  • Event-driven AI architecture
  • Scaling AI agents in production
  • Best practices for enterprise deployment

Video Tutorials (Coming Soon)

  • Quick start walkthrough
  • Building production-ready agents
  • Monitoring and debugging

🏢 Enterprise Support

For businesses requiring dedicated support:

What's Included

  • ✅ Dedicated Slack Channel - Direct line to maintainers
  • ✅ Priority Bug Fixes - Your issues get top priority
  • ✅ Architecture Consulting - Help designing your system
  • ✅ Custom Integrations - Build custom event bus/storage backends
  • ✅ SLA Guarantees - Guaranteed response times
  • ✅ Training Workshops - Onboard your team
  • ✅ Code Review - Review your OmniDaemon implementation
  • ✅ Migration Assistance - Help migrating from other systems

Pricing

Contact us for custom enterprise support packages.

Contact: mintify.com

🐛 Reporting Issues

Before Reporting

  1. Search existing issues - Your issue may already be reported
  2. Try latest version - Bug might already be fixed
  3. Minimal reproduction - Create smallest code that reproduces the bug

Bug Report Template

Use this template when reporting bugs:

**Bug Description**
Clear description of the bug.

**To Reproduce**
Steps to reproduce:
1. Install OmniDaemon
2. Run this code...
3. See error

**Expected Behavior**
What you expected to happen.

**Actual Behavior**
What actually happened.

**Code Example**
```python
# Minimal reproducible example
from omnidaemon import OmniDaemonSDK

sdk = OmniDaemonSDK()
# Code that triggers bug...

Environment

  • OmniDaemon version: 0.1.0
  • Python version: 3.11.5
  • OS: Ubuntu 22.04
  • Event bus: Redis 7.0

Traceback

Full error traceback here


[Create Bug Report →](https://github.com/omnirexflora-labs/OmniDaemon/issues/new)

---

## 💡 Feature Requests

### Suggesting Features

We love feature suggestions! Here's how to make a great request:

1. **Explain the problem** you're trying to solve
2. **Describe your proposed solution**
3. **Share your use case** - How would you use this?
4. **Consider alternatives** - Are there other ways to solve this?

### Feature Request Template

```markdown
**Problem**
Describe the problem you're trying to solve.

**Proposed Solution**
Your suggested implementation.

**Example**
```python
# How the API might look
await sdk.new_feature(...)

Alternatives Other solutions you've considered.

Additional Context Any other relevant information.


[Request Feature →](https://github.com/omnirexflora-labs/OmniDaemon/issues/new)

---

## 🤝 Contributing

Want to contribute to OmniDaemon?

- **Code contributions** - Bug fixes, features, tests
- **Documentation** - Improve docs, write tutorials
- **Community support** - Help others in Discussions
- **Share your projects** - Showcase what you built

**See:** [Contributing Guide](./contributing.md)

---

## 📰 Stay Updated

### GitHub

**Star the repo** to get updates: [omnirexflora-labs/OmniDaemon](https://github.com/omnirexflora-labs/OmniDaemon)

**Watch releases** to get notified of new versions.

### Social Media

- **X (Twitter):** [@abiorhmangana](https://x.com/abiorhmangana)
- **Website:** [mintify.com](https://mintify.com)

### Release Notes

Check [GitHub Releases](https://github.com/omnirexflora-labs/OmniDaemon/releases) for:
- New features
- Bug fixes
- Breaking changes
- Migration guides

---

## 🙏 Acknowledgments

### Core Team

- **[Abiola Adeshina](https://github.com/Abiorh001)** - Creator & Lead Maintainer

### Contributors

Thanks to all contributors who have helped make OmniDaemon better!

[View all contributors →](https://github.com/omnirexflora-labs/OmniDaemon/graphs/contributors)

### Open Source Projects

OmniDaemon is built on the shoulders of giants:

- **[FastAPI](https://fastapi.tiangolo.com/)** - Modern Python web framework
- **[Typer](https://typer.tiangolo.com/)** - CLI framework
- **[Rich](https://github.com/Textualize/rich)** - Beautiful terminal output
- **[Pydantic](https://pydantic.dev/)** - Data validation
- **[Redis](https://redis.io/)** - In-memory data store
- **[Python](https://python.org/)** - Programming language

---

## 📞 Contact

### General Inquiries

- **GitHub:** [@Abiorh001](https://github.com/Abiorh001)
- **X (Twitter):** [@abiorhmangana](https://x.com/abiorhmangana)
- **Website:** [mintify.com](https://mintify.com)

### Enterprise Sales

For enterprise support, custom integrations, or partnerships:

**Contact:** [mintify.com](https://mintify.com)

### Security Issues

**DO NOT** open public issues for security vulnerabilities.

**Report privately via GitHub:** [Security advisories](https://github.com/omnirexflora-labs/OmniDaemon/security/advisories/new)

Or email: security@mintify.com

---

## ❓ FAQ

### General

**Q: Is OmniDaemon free?**
A: Yes! OmniDaemon is open source (MIT license). Enterprise support is available for purchase.

**Q: Which AI frameworks are supported?**
A: All of them! OmniDaemon is framework-agnostic. Use OmniCore Agent, Google ADK, LangChain, CrewAI, or any Python callable.

**Q: Do I need Redis?**
A: Redis is the default backend, but OmniDaemon is pluggable. Kafka, RabbitMQ, and other backends are on the roadmap.

**Q: Can I use OmniDaemon in production?**
A: Absolutely! OmniDaemon is designed for production use with features like DLQ, retries, metrics, and horizontal scaling.

### Technical

**Q: How do I scale OmniDaemon?**
A: Just run more agent runner processes. They automatically load balance via consumer groups.

**Q: How are failures handled?**
A: Automatic retries with exponential backoff. After N retries, messages go to Dead Letter Queue (DLQ) for manual review.

**Q: Can I run multiple agents?**
A: Yes! Register multiple agents in one runner, or run multiple runners with different agents.

**Q: How do I monitor agents?**
A: Use `omnidaemon health`, `omnidaemon metrics`, and `omnidaemon bus` commands. Prometheus integration coming soon.

### Troubleshooting

**Q: Agent not receiving messages?**
A: Check consumer group with `omnidaemon bus groups --topic your.topic`

**Q: High memory usage?**
A: Reduce `OMNIDAEMON_DEFAULT_MAXLEN` to limit stream size.

**Q: Messages in DLQ?**
A: Check with `omnidaemon bus dlq --topic your.topic` and inspect errors.

**See full troubleshooting:** [README Troubleshooting](https://github.com/omnirexflora-labs/OmniDaemon/blob/main/README.md#troubleshooting)

---

## 🎯 Community Guidelines

### Be Respectful

- Treat everyone with respect
- Be welcoming to newcomers
- Accept constructive criticism gracefully
- Focus on what's best for the community

### Be Helpful

- Answer questions when you can
- Share your knowledge
- Provide code examples
- Point to relevant documentation

### Be Professional

- No spam or self-promotion
- Stay on topic
- No trolling or harassment
- Keep discussions productive

---

**Thank you for being part of the OmniDaemon community!** 🚀

**Questions?** [Ask on GitHub Discussions](https://github.com/omnirexflora-labs/OmniDaemon/discussions)