Skip to content

FAQ.md

Latest commit

 

History

History
315 lines (226 loc) · 9.36 KB

FAQ.md

File metadata and controls

315 lines (226 loc) · 9.36 KB
Raw

❓ Frequently Asked Questions (FAQ)

Welcome to the Yaqeen FAQ! Here you'll find answers to the most common questions about our platform, features, and development.

📋 Table of Contents

🌟 General Questions

What is Yaqeen?

Yaqeen is a comprehensive Islamic digital platform that provides:

  • Quran Studies: Complete Quran text with translations and tafsir
  • Hadith Collections: Authentic hadith from established sources
  • Educational Tools: Learning resources and interactive features
  • Spiritual Content: Adhkar, duas, and Islamic articles

Our mission is to make Islamic knowledge accessible through modern technology while maintaining authenticity and scholarly accuracy.

Is Yaqeen free to use?

Yes! Yaqeen is completely free and open-source. We believe Islamic knowledge should be accessible to everyone without barriers.

What languages does Yaqeen support?

Currently, Yaqeen primarily supports Arabic with English translations. We plan to add more languages including:

  • Urdu
  • Indonesian
  • French
  • German
  • And more based on community demand

How accurate is the content?

We prioritize accuracy and authenticity:

  • Quran Text: Sourced from authenticated manuscripts
  • Translations: From reputable scholars and institutions
  • Hadith: From sahih (authentic) collections with grading
  • Tafsir: From established classical and contemporary sources

All content is reviewed by Islamic scholars and subject matter experts.

💻 Technical Questions

What technologies does Yaqeen use?

Yaqeen is built with modern web technologies:

  • Frontend: Next.js 16 (React framework)
  • Styling: Tailwind CSS 4
  • Language: JavaScript (ES6+)
  • Deployment: Vercel
  • Database: PostgreSQL (planned)
  • API: RESTful with GraphQL integration (planned)

Can I use Yaqeen offline?

Currently, Yaqeen requires an internet connection. However, we plan to add:

  • Offline reading capabilities
  • Downloadable content
  • Progressive Web App (PWA) features
  • Mobile apps with offline support

Is Yaqeen mobile-friendly?

Yes! Yaqeen is fully responsive and works on:

  • Desktop computers
  • Tablets
  • Smartphones
  • Mobile apps (planned for iOS and Android)

How fast is Yaqeen?

We optimize for performance:

  • Fast loading: Under 3 seconds for most pages
  • Efficient code: Modern React with code splitting
  • CDN delivery: Global content delivery network
  • Caching: Smart caching strategies

📚 Content Questions

What Quran translations are available?

Yaqeen offers multiple translations including:

  • Saheeh International (recommended for English speakers)
  • Dr. Mustafa Khattab (The Clear Quran)
  • Muhammad Taqi-ud-Din al-Hilali & Muhammad Muhsin Khan
  • Abdullah Yusuf Ali
  • And more translations planned

Which hadith collections are included?

We include the most authentic hadith collections:

  • Sahih al-Bukhari (7,275 hadith)
  • Sahih Muslim (5,033 hadith)
  • Sunan al-Tirmidhi (3,956 hadith)
  • Sunan Ibn Majah (4,341 hadith)
  • Sunan al-Nasa'i (5,270 hadith)
  • Sunan Abu Dawood (5,274 hadith)

Each hadith includes authenticity grading and references.

What tafsir sources are available?

Yaqeen provides access to renowned tafsir works:

  • Tafsir Ibn Kathir (Classical, comprehensive)
  • Tafsir al-Jalalayn (Concise, accessible)
  • Tafsir al-Saadi (Modern, clear explanations)
  • Contemporary tafsir (Modern scholarly works)

How do you ensure content quality?

Our quality assurance process includes:

  • Scholarly Review: Content reviewed by Islamic scholars
  • Source Verification: All references checked against original sources
  • Peer Review: Community and expert feedback
  • Regular Updates: Content updated with latest research
  • User Feedback: Community reporting of issues

👤 Account & Privacy

Do I need to create an account?

Currently, you can use Yaqeen without an account. However, we plan to add:

  • User accounts for personalized features
  • Bookmarks and reading history
  • Custom study plans
  • Community features

How is my privacy protected?

We take privacy seriously:

  • No personal data collection without consent
  • Secure data transmission (HTTPS everywhere)
  • No tracking without explicit permission
  • GDPR compliant data handling
  • Transparent privacy policy

Can I delete my data?

Yes, if you create an account, you can:

  • Delete your account at any time
  • Export your data before deletion
  • Request data removal from our systems

🤝 Contributing

How can I contribute to Yaqeen?

There are many ways to contribute:

  • Report bugs using our bug report template
  • Suggest features via feature request template
  • Improve documentation by editing our docs
  • Translate content to other languages
  • Write code and submit pull requests
  • Test features and provide feedback

Do I need to be a developer to contribute?

No! We welcome all types of contributions:

  • Content creators can help with Islamic content
  • Designers can improve our UI/UX
  • Translators can help with localization
  • Testers can help find and report bugs
  • Writers can improve documentation

How do I report a bug?

Use our bug report template:

  1. Search existing issues first
  2. Use the template to provide all details
  3. Include screenshots if applicable
  4. Provide steps to reproduce

How do I suggest a feature?

Use our feature request template:

  1. Check existing requests first
  2. Describe the problem you're solving
  3. Explain your solution clearly
  4. Provide use cases and benefits

🔧 Troubleshooting

Why is the page not loading?

Common solutions:

  • Check your internet connection
  • Clear browser cache (Ctrl+F5 or Cmd+Shift+R)
  • Try a different browser
  • Disable browser extensions temporarily
  • Check our status page for outages

Why are some features not working?

Possible causes:

  • Browser compatibility - Try Chrome or Firefox
  • JavaScript disabled - Enable JavaScript in browser settings
  • Ad blockers - Some features may be blocked
  • Outdated browser - Update to the latest version

How do I clear my browser cache?

Chrome:

  1. Press Ctrl+Shift+Delete (Windows) or Cmd+Shift+Delete (Mac)
  2. Select "Cached images and files"
  3. Click "Clear data"

Firefox:

  1. Press Ctrl+Shift+Delete (Windows) or Cmd+Shift+Delete (Mac)
  2. Select "Cache"
  3. Click "Clear"

The audio is not playing. What should I do?

Audio issues can be caused by:

  • Browser restrictions - Click anywhere on the page first
  • Ad blockers - Disable for Yaqeen
  • Network issues - Check your internet connection
  • Browser settings - Ensure media autoplay is enabled

I'm having trouble with Arabic text display.

Arabic text issues:

  • Install Arabic fonts on your system
  • Enable RTL support in browser settings
  • Use a compatible browser (Chrome, Firefox, Safari)
  • Check font rendering settings

📞 Support & Contact

How do I get help?

Multiple support channels:

What are your support hours?

  • Email Support: Monday-Friday, 9 AM - 6 PM (UTC+3)
  • Community Support: 24/7 through GitHub
  • Emergency Issues: Critical bugs addressed ASAP

How long does it take to get a response?

  • Bug Reports: Acknowledged within 24 hours
  • Feature Requests: Initial response within 1 week
  • General Questions: Usually within 24 hours
  • Critical Issues: Immediate attention

🎯 Future Plans

What's coming next?

Our roadmap includes:

  • Mobile Apps (iOS and Android)
  • Offline Mode for reading without internet
  • AI-Powered Features for personalized learning
  • Multi-language Support for global reach
  • Community Features for user interaction

How can I stay updated?

Stay in the loop:

  • 📧 Newsletter: Subscribe for updates
  • 🐙 GitHub: Watch our repository
  • 📱 Social Media: Follow our accounts
  • 📰 Blog: Read our development updates

🤔 Still Have Questions?

Can't find what you're looking for? Here's how to get help:

  1. Search this FAQ - Use Ctrl+F to search for keywords
  2. Check GitHub Issues - See if others had similar questions
  3. Ask the Community - Post in GitHub Discussions
  4. Contact Support - Email us at support@yaqeen.dev

Before Contacting Support

Please include:

  • What you were trying to do
  • What you expected to happen
  • What actually happened
  • Your browser and device information
  • Any error messages you saw

This FAQ is regularly updated. If you have a question that should be added here, please let us know!