Official documentation for the RevenueHunt Product Recommendation Quiz app — a powerful e-commerce solution for creating interactive product quizzes, collecting zero-party data, and delivering personalized product recommendations.
Live Documentation: https://docs.revenuehunt.com
RevenueHunt is a product recommendation quiz app for e-commerce platforms that helps online stores:
- Increase conversions with personalized product recommendations
- Collect zero-party data through interactive quizzes
- Segment customers based on quiz responses
- Integrate with marketing tools like Klaviyo, HubSpot, Mailchimp, and more
- Support multiple platforms: Shopify, WooCommerce, Magento, BigCommerce, and Standalone
This documentation follows the Diátaxis framework:
| Section | Purpose | Example Topics |
|---|---|---|
| Tutorials | Learning-oriented guides | Making your first quiz, Quiz design basics |
| How-to Guides | Task-oriented instructions | Add discounts, Integrate analytics, Publish quiz |
| App Manual | Technical reference | Quiz Builder, Dashboard, API settings |
| Customer Success | Business guidance | Conversion optimization, Best practices |
- Quiz Creation: Building product recommendation quizzes with conditional logic
- Product Recommendations: Linking products, collections, and recommendation algorithms
- Quiz Design: Customizing appearance, branding, and user experience
- Integrations: Klaviyo, HubSpot, Mailchimp, Omnisend, Zapier, Google Analytics, Meta Pixel
- Publishing: Embedding quizzes inline, popup, chat widget, or external links
- Analytics: Tracking quiz performance, revenue attribution, and conversion metrics
- Multi-language & Multi-currency: Supporting international stores and Shopify Markets
- Python 3.8+
- pip
# Clone the repository
git clone https://github.com/RevenueHunt/docs.git
cd docs
# Install dependencies
pip install -r requirements.txt
# Serve locally with hot reload
mkdocs serveThe documentation will be available at http://127.0.0.1:8000.
# Build static site
mkdocs buildOutput is generated in the site/ directory.
docs/
├── docs/ # Documentation content
│ ├── tutorials/ # Step-by-step learning guides
│ ├── how-to-guides/ # Task-oriented instructions
│ ├── reference/ # Technical reference (App Manual)
│ ├── customer-success/ # Business guidance and best practices
│ └── images/ # Screenshots and diagrams
├── plugins/ # Custom MkDocs plugins
├── mkdocs.yml # MkDocs configuration
├── requirements.txt # Python dependencies
└── rename_images.rb # Utility for image file naming
- Static Site Generator: MkDocs
- Theme: Material for MkDocs
- Markdown Extensions: PyMdown Extensions (tabs, admonitions, code highlighting)
- Search: Built-in MkDocs search with suggestions and highlighting
- Analytics: Google Analytics 4
This repository includes generated documentation files for training AI assistants:
shopify.txt— Shopify-specific documentationshopify-legacy.txt— Shopify Legacy documentationwoocommerce.txt— WooCommerce-specific documentation
See README_DOCS_GENERATOR.md for details on regenerating these files.
When contributing to this documentation:
- Follow the established content taxonomy (tutorials vs how-to vs reference)
- Use Material theme conventions for formatting
- Store images in
docs/images/without spaces in filenames - Test locally with
mkdocs servebefore submitting changes - Use platform-specific tabs for multi-platform instructions
- Product Website: https://revenuehunt.com
- Shopify App: Shopify App Store
- WooCommerce Plugin: WordPress Plugin Directory
- Support: Contact Support
This documentation is proprietary to RevenueHunt. All rights reserved.
Built with MkDocs and Material for MkDocs