GuidePlugin DocsGetting Started
Quick setup guide to create your first GuidePlugin guide in minutes.
Welcome to GuidePlugin! This guide will walk you through creating your first complete guide in just a few minutes. Follow these steps to get up and running quickly.
Quick Start Overview
| Step | Component | Time Required | Purpose |
|---|---|---|---|
| 1 | Facets | 5 minutes | Define data characteristics |
| 2 | Filters | 10 minutes | Create user questions |
| 3 | Guide | 5 minutes | Combine everything together |
| 4 | Index | 2 minutes | Build searchable database |
Step-by-Step Setup
Create Facets
Start by defining the characteristics users can filter by:
Essential Facets for Most Sites:
| Facet Type | Data Source | Example Values |
|---|---|---|
| Category | Post categories | Technology, Design, Business |
| Price Range | Custom field or WooCommerce | $0-50, $51-100, $101+ |
| Content Type | Post types | Articles, Products, Services |
Start Simple: Begin with 3-4 basic facets. You can always add more later as your needs grow.
Go to GuidePlugin > Facet > Create and add your first facets.
Create Filters
Transform facets into user-friendly questions:
Example Filter Questions:
- "What's your budget range?"
- "What type of content interests you?"
- "Which category are you looking for?"
- "How many rooms do you need?"
For each filter:
- Write a clear, simple question
- Link it to your facets
- Choose the appropriate filter type (cards, slider, etc.)
- Add help text if needed
Go to GuidePlugin > Filter > Create for each question.
Create Your Guide
Combine filters into a complete experience:
Guide Configuration:
- Introduction - Brief welcome message
- Filter Selection - Add your created filters in logical order
- Design - Choose or create visual styling
- Results - Configure how many results to show
- Content Scope - Include/exclude specific content types
Go to GuidePlugin > Guides > Create to build your guide.
Build Index
Create the searchable database:
Go to GuidePlugin > Settings > Index and click "Reindex".
This scans all your WordPress content and creates an optimized database for fast filtering.
Indexing Time: Large sites may take a few minutes. You'll see progress updates during the process.
First Guide Checklist
Before going live, verify these essential elements:
| Component | Check | Status |
|---|---|---|
| Facets Created | At least 3 facets with real data | |
| Filters Working | Each filter shows options and connects to facets | |
| Guide Complete | All sections configured, filters added in order | |
| Index Built | Recent indexing completed successfully | |
| Results Display | Test guide shows relevant results |
Testing Your Guide
Quick Test Process
- Navigate to your guide's preview URL
- Complete the entire filtering process
- Verify results match your selections
- Check mobile responsiveness
- Test different filter combinations
Common First-Time Issues
| Problem | Quick Fix |
|---|---|
| No results showing | Run reindex, check include/exclude settings |
| Empty filter options | Verify facets have data in your content |
| Guide won't load | Check all required fields are filled |
| Slow performance | Optimize facet data sources |
Displaying Your Guide
Add your guide to any page using:
Shortcode Method
[guideplugin id="YOUR_GUIDE_ID"]Widget Method
- Go to Appearance > Widgets
- Add GuidePlugin Widget
- Select your guide
- Configure display options
Theme Integration
<?php echo do_shortcode('[guideplugin id="YOUR_GUIDE_ID"]'); ?>What's Next?
Once your basic guide is working:
| Enhancement | Purpose | Priority |
|---|---|---|
| Custom Templates | Style result displays | Medium |
| Advanced Logic | Add conditional behavior | Low |
| Custom Designs | Brand your guide appearance | Medium |
Congratulations! You now have a working GuidePlugin guide. Users can filter your content and find exactly what they're looking for.