What is Miruni's Snippet?
Miruni's snippet solution offers a streamlined way to capture and manage website feedback and edit requests without the typical hassles of traditional feedback tools:
- No Browser Extensions Required: Unlike many feedback tools, Miruni works directly through a simple JavaScript snippet - no extensions or additional software needed
- Universal Compatibility: Works across all major browsers and devices
- Lightweight Implementation: Minimal impact on your site's performance
- Secure & Privacy-Focused: All data is encrypted and handled securely
- Real-Time Updates: Instant feedback capture and notification system
- Contextual Feedback: Automatically captures technical context (browser info, screen size, etc.)
- Easy Integration: Simple copy-paste implementation that works with any web framework
Initial Setup
Step 1: Generate Your Snippet
1. Navigate to your project settings pane in Miruni
2. Look for the "Generate Snippet" section
3. For edit request type settings, use the default options
- Default settings ensure optimal compatibility and performance
- You can customize these later based on your needs
4. Click the "Generate" button
5. Your unique snippet code will be generated
- Each snippet is project-specific and contains your unique identifier
- The snippet is automatically optimized for performance
Step 2: Copy the Snippet
1. Once generated, you'll see your unique snippet code
2. Click the copy icon (two overlaid boxes) to automatically copy the code to your clipboard
- This saves time and prevents copy/paste errors
- The code is automatically formatted for HTML implementation
Step 3: Install the Snippet
1. Add the snippet code to your website's HTML:
<!-- Add this inside your <head> tag -->
<head>
<!-- Your existing head content -->
[Your Miruni snippet code will go here]
</head>
2. Important notes:
- The snippet should be placed inside the `<head>` tag for optimal loading
- Include the snippet on every page where you want to receive edit requests
- The snippet is designed to load asynchronously, not impacting page load times
- If someone else manages your site, forward them the snippet code for implementation
- The snippet automatically overlays on top of your site's theme and layout
- Snippet will note capture screenshots on websites thare not utilizing SSL (HTTPS://) for security reasons.
Using Edit Requests
For Your Users
1. Account Requirements:
- Users need a Miruni account to leave feedback
- You can invite users to your project as guests
- Send them an invitation through your Miruni dashboard
- Guest accounts have limited permissions to ensure security
2. Accessing the Feedback Tool:
- Users must be logged into their Miruni account
- When visiting your site, they'll see the Miruni snippet interface on the side that says 'Give Feedback'
- The interface is discreet but easily accessible
- Clicking the 'Give Feedback' button opens the tool box, and the user can select the region capture tool to being the process of leaving feedback or logging an edit request.
- Users can collapse the interface when not in use
3. Leaving Feedback:
- Users can highlight specific sections of your site
- The selection tool is precise and easy to use
- They can add descriptions of needed changes or feedback
- The tool captures the context automatically, including:
* Screenshots of the selected area
* Page URL and location
* Browser and device information
* Time and date of submission
For You (Admin Features)
1. Managing Requests:
- All feedback appears in your Miruni dashboard
- Requests are organized by priority and type
- You can track, prioritize, and manage requests
- Updates automatically notify stakeholders
- Built-in collaboration tools for team discussion and comments
2. Organization Features:
- Tag and categorize feedback
- Assign requests to team members
- Set priority levels
- Track status and progress
- Generate reports and analytics
Best Practices
- Test the snippet on a staging environment first
- Test the snippet on different page types of your site
- Consider setting up user guidelines for feedback submission to ensure high quality data
- Regularly check your dashboard for new requests
- Set up notification preferences to stay informed
- Use tags and categories to organize feedback effectively
- Establish internal processes for handling different types of requests
Troubleshooting
If the snippet isn't appearing:
1. Verify the snippet code is correctly placed in the `<head>` section
2. Check if the user is logged into their Miruni account
4. Clear browser cache and refresh the page
5. Check console for any JavaScript errors and let us know in support
Common Issues:
- Snippet not loading: Check for JavaScript errors or conflicts with other included javascript libraries and let us know what you find.
- Feedback tool not showing: Verify user is logged into Miruni.
- Notifications not receiving: Check email isn't in Junk folders and notification settings are correct.
Need help? Contact Miruni support for assistance with setup and configuration.