Support¶
Need help with Folder2MD4LLMs? Here are the best ways to get assistance and connect with the community.
🔍 Before Asking for Help¶
Check the Documentation¶
- Installation Guide - Setup and installation issues
- First Conversion - Basic usage walkthrough
- Quick Reference - Common commands and patterns
- Configuration Guide - Advanced configuration options
- Troubleshooting - Common issues and solutions
Search Existing Issues¶
Check if your question has already been answered: - GitHub Issues - GitHub Discussions
💬 Getting Help¶
GitHub Discussions (Recommended)¶
Best for: General questions, usage help, feature discussions
- Q&A: Ask questions and get help from the community
- Ideas: Suggest new features or improvements
- Show and Tell: Share your use cases and configurations
- General: General discussion about the project
GitHub Issues¶
Best for: Bug reports, specific problems, feature requests
When reporting an issue, please include:
## Environment
- OS: [e.g., macOS 13.0, Ubuntu 22.04, Windows 11]
- Python version: [e.g., 3.11.5]
- Folder2MD4LLMs version: [run `folder2md --version`]
- Installation method: [pip, pipx, binary, etc.]
## Description
[Clear description of the issue]
## Steps to Reproduce
1. Run command: `folder2md ...`
2. Expected behavior: [what should happen]
3. Actual behavior: [what actually happens]
## Configuration
```yaml
# Include your folder2md.yaml if relevant
Error Output¶
## 🐛 Bug Reports
### What Makes a Good Bug Report?
#### ✅ Good Example:
- **Clear title**: "PDF conversion fails with 'Binary content detected' error"
- **Environment details**: OS, Python version, installation method
- **Reproducible steps**: Exact commands and file types used
- **Expected vs actual behavior**: What should happen vs what happens
- **Error messages**: Complete error output
- **Sample files**: If possible, provide a minimal example file
#### ❌ Poor Example:
- **Vague title**: "It doesn't work"
- **No environment info**: "Installed on my laptop"
- **No steps**: "Tried to convert my project"
- **No error details**: "Got an error"
### Priority Levels
We triage issues based on:
- **🔴 Critical**: Security issues, data loss, crashes
- **🟠 High**: Major functionality broken for many users
- **🟡 Medium**: Important features not working as expected
- **🟢 Low**: Minor issues, cosmetic problems, edge cases
## 🆘 Emergency Support
### Critical Issues
For security vulnerabilities or critical bugs:
1. **Do not** post in public discussions
2. Email: [[email protected]](mailto:[email protected])
3. Include "SECURITY" in the subject line
### Commercial Support
For organizations needing dedicated support:
- Contact: [[email protected]](mailto:[email protected])
- Custom integrations and consulting available
## 🤝 Community Guidelines
### Be Respectful
- Use inclusive language
- Be patient with newcomers
- Provide constructive feedback
- Respect different use cases and perspectives
### Be Helpful
- Search before asking duplicate questions
- Provide clear, complete information
- Share solutions that worked for you
- Help others when you can
### Be Specific
- Use descriptive titles
- Include relevant details
- Provide minimal reproducible examples
- Format code and logs properly
## 📚 Self-Help Resources
### Common Commands for Debugging
```bash
# Check version
folder2md --version
# Test configuration
folder2md --config folder2md.yaml --dry-run --verbose
# See what files would be processed
folder2md . --dry-run --include-pattern "**/*.py"
# Enable verbose logging
folder2md . --verbose
# Test with minimal settings
folder2md . --output test.md --no-smart-condensing
Log Analysis¶
Enable verbose mode to get detailed logs:
Look for: - File filtering decisions - Token counting information - Conversion errors or warnings - Memory usage information
Configuration Validation¶
🔗 Useful Links¶
Documentation¶
Community¶
HenriquesLab¶
📈 Response Times¶
We aim for: - Critical issues: Within 24 hours - Bug reports: Within 3-5 days - Feature requests: Within 1-2 weeks - General questions: Community-driven (usually within 1-3 days)
Note: These are volunteer efforts, so response times may vary during busy periods or holidays.
🎯 Getting Faster Help¶
Do This:¶
- Search existing issues first
- Provide complete environment details
- Include minimal reproducible examples
- Use clear, descriptive titles
- Format code and logs properly
Avoid This:¶
- Posting the same question in multiple places
- Providing incomplete information
- Using vague titles like "Help" or "Broken"
- Expecting immediate responses
- Being demanding or impatient
Remember: The Folder2MD4LLMs community is built on mutual help and respect. The more helpful and detailed you are in your questions, the better and faster help you'll receive!