Documentation
SiteDocs
Troubleshooting

Troubleshooting

Sections Say "No connector selected yet"

Select a connector

Go to Tools → SiteDocs → Settings → AI Provider, choose one under Select Connector, and click Save Settings.

Regenerate

Click Regenerate Documentation on the Documentation tab.


Sections Show an "AI Connector error"

Check the connector

Go to Settings → Connectors and confirm the provider is connected with a valid API key that has credit.

Check server connectivity

Make sure your server can reach the provider's API (no outgoing firewall block).

Check the Status tab

AI-generated descriptions should show Connected.

Regenerate

Click Regenerate Documentation.


Generation Times Out

Every section is a separate AI request made in one go, so sites with many content types, field groups or settings pages can hit PHP's max_execution_time. Raise the limit (check it in Handover Tools → Server Environment Snapshot) and try again.


A Custom Post Type Is Missing

Only public, non-built-in post types are documented. Check that the post type is registered with public => true and that the plugin registering it is active, then regenerate.


My Edits Disappeared

Edited sections are only replaced when you regenerate with Keep my edited sections unticked. Automatic regenerations always keep them. Clicking Clear Documentation deletes everything, including edits.


Export Fails

Check write permissions

SiteDocs writes to wp-content/uploads/sitedocs/. Make sure the uploads folder is writable.

Generate first

The export needs generated documentation.


Dashboard Widget Not Showing

Check the setting

Dashboard Quick Links Widget must be on under Settings → Client Engagement.

Generate documentation

The widget only appears once documentation exists.

Check Screen Options

Click Screen Options at the top of the dashboard and make sure the widget is ticked.