Troubleshooting common issues
Use this guide to fix the most common PinkDocs problems. Find your problem below and follow the steps.
Before you start
Most problems are fixed by these three checks. Try them first.
Refresh your permalinks
Go to Settings → Permalinks and click Save Changes without changing anything.
Clear your caches
Clear your caching plugin, your host's cache and your browser cache.
Update PinkDocs
Go to Plugins and install any available PinkDocs update. Check your licence is active under PinkDocs → License.
My docs show Page not found
Refresh permalinks
Go to Settings → Permalinks and click Save Changes.
Check the doc is published
Open the doc and check its status is Published.
Check for slug conflicts
Make sure no page or post on your site uses the same slug as your docs base, such as docs.
My help centre looks broken or unstyled
Clear your caches
Clear all caches, including any CSS minification or combining in your performance plugin.
Exclude PinkDocs from optimisation
In your performance plugin, exclude PinkDocs CSS and JavaScript files from combining and delaying.
Test for a theme conflict
Switch temporarily to a default theme, such as Twenty Twenty-Five. If the problem disappears, contact support with your theme name.
📷 Image placeholder: a performance plugin's exclusion settings with PinkDocs files added.
Live search shows no results
- Check the docs are published.
- Clear your cache.
- Check that a security plugin isn't blocking requests to
/wp-json/pinkdocs/.
The AI assistant isn't responding
Test the AI connection
Go to PinkDocs → Settings → AI and click Test connection.
Check your provider account
Make sure your API key is valid and your provider account has billing set up and credits available.
Check the assistant is turned on
Make sure AI assistant is enabled and saved.
Blocks show an error in the editor
If a block shows This block contains unexpected content, select it and click Attempt recovery. If that doesn't work, click the three-dot menu and choose Convert to HTML, then re-add the block.
Find plugin conflicts
Deactivate other plugins
On a staging site, deactivate every plugin except PinkDocs.
Check the problem
If the problem is gone, reactivate plugins one at a time, checking after each.
Report the conflict
When the problem returns, you've found the conflicting plugin. Contact support with its name.
