Skip to main content

Getting help

If you need assistance with GitRead, we’re here to help. This page provides information on how to get support, report issues, and find answers to your questions.

Contact information

For any issues, questions, or feedback, please contact us:

Email support

When contacting support, please include:
  • A clear description of your issue or question
  • The repository URL you were trying to use (if applicable)
  • Any error messages you received
  • Screenshots or screen recordings if relevant
  • Your account email (if related to credits or authentication)

Before contacting support

To help us resolve your issue quickly, please:
  1. Check the FAQ - Many common questions are answered in our FAQ section
  2. Review troubleshooting - Common errors and solutions are documented in Troubleshooting
  3. Verify your repository - Ensure your GitHub repository URL is valid and the repository is public
  4. Check your credits - Confirm you have available credits in your account
  5. Try again - Some temporary issues resolve themselves after a brief wait

Common support requests

Credit and billing issues

If you have questions about:
  • Credit purchases not reflecting in your account
  • Payment processing errors
  • Refund requests
  • Billing inquiries
Please email [email protected] with your account email and transaction details.
Payment processing can take a few minutes. If your credits don’t appear immediately after purchase, wait 5 minutes and refresh the page before contacting support.

Technical issues

For technical problems such as:
  • Generation failures
  • Error messages
  • Application bugs
  • Performance issues
Please provide:
  • The exact error message you received
  • The repository URL that caused the issue
  • When the issue occurred
  • Any steps to reproduce the problem

Account issues

For authentication or account-related concerns:
  • Sign-in problems
  • Account access issues
  • Credit balance discrepancies
  • README history not displaying
Contact [email protected] with your account email address.

Feature requests

We welcome feedback and feature suggestions. If you have ideas for improving GitRead, please email us with:
  • A description of the feature you’d like to see
  • The problem it would solve
  • How you would use this feature

Response times

We strive to respond to all support inquiries within:
  • Critical issues (service outages, payment problems): 24 hours
  • General inquiries: 48-72 hours
  • Feature requests: 1 week
Response times may be longer during weekends and holidays. We appreciate your patience.

Self-service resources

Before reaching out, explore these resources:

FAQ

Find answers to frequently asked questions about credits, usage, and features

Troubleshooting

Diagnose and resolve common errors and issues

Getting started

Learn how to use GitRead effectively

API reference

Technical documentation for developers

Known issues

We maintain transparency about current issues:

Repository size limitations

GitRead has token limits (900,000 tokens maximum) that may prevent processing of very large repositories. This is a platform limitation to ensure reliable service for all users. Workaround: Use smaller repositories or contact support to discuss options for large projects.

Queue during high traffic

During peak usage times, you may encounter queue positions or “server busy” messages. This is normal and helps maintain service quality. Workaround: Wait 30-60 seconds and try again. Your request will be processed in order.

Private repository support

GitRead currently only supports public GitHub repositories. Private repository support is not available. Workaround: Make your repository temporarily public during README generation, or contact support about alternatives.

Report security issues

If you discover a security vulnerability or privacy concern, please email [email protected] immediately with:
  • A description of the vulnerability
  • Steps to reproduce (if applicable)
  • Potential impact
Please do not publicly disclose security issues until we’ve had a chance to address them.

Social media

Follow us for updates and announcements:

Twitter/X

@koyalhq

Service status

GitRead uses several third-party services:
  • GitHub - Repository access
  • OpenRouter/Gemini - AI generation
  • Clerk - Authentication
  • Stripe - Payment processing
  • Supabase - Database
If you’re experiencing issues, they may be related to service disruptions from these providers. Check their status pages if GitRead is not functioning normally.

Feedback

We value your feedback and use it to improve GitRead. Share your thoughts about:
  • Features you love
  • Areas for improvement
  • User experience suggestions
  • Documentation clarity
Email your feedback to [email protected].
GitRead is created and maintained by @koyalhq. We’re committed to providing excellent service and support.

Build docs developers (and LLMs) love