Documentation
SiteDocs
Site Scanner

Site Scanner


What Is Scanned

SiteDocs scans the following aspects of your WordPress installation:

CategoryDetails Captured
Custom Post TypesCPT names, labels, supports, taxonomies, REST API status
ACF Field GroupsGroup titles, location rules, field names, field types, settings
Plugin SettingsActive plugins with version, author, description
WooCommerceShop page, currency, payment gateways (active), shipping zones, tax settings, product counts
BrandSite name, tagline, logo attachment ID, colour scheme
EnvironmentPHP version, WordPress version, MySQL version, active theme (name, version, author), defined constants
IntegrationsDetected integration map of known plugin combinations
Dependency TreeWhich plugins depend on each other

Scan Meta:

FieldDescription
site_nameWordPress get_bloginfo('name')
site_urlSite URL
scanned_atISO 8601 timestamp of scan
wp_versionWordPress version string
active_themeTheme name, version, author

Running a Scan

Open the Generate screen

Go to Tools → SiteDocs → Generate.

Start the scan

Click Scan Site.

Review scan results

The scanner collects data from WordPress APIs (no external requests). Scan results are displayed in a collapsible JSON preview.

Generate documentation

Click Generate Documentation to send scan data to the AI provider.

The generation process takes 30–120 seconds depending on the AI provider and site complexity. A progress indicator shows the current section being generated.


Rescan Detection

SiteDocs monitors for new custom post types after the initial scan. When a new CPT is registered (by a newly installed plugin, for example), the sitedocs_needs_rescan option is set to 1.

When this flag is set:

  • A notice appears in the SiteDocs admin panel recommending a rescan.
  • If Auto-Generate is enabled, the next scheduled run will automatically rescan.

Confirm CPTs are registered at init with priority ≤ 10 - SiteDocs scans at priority 20. CPTs registered at a higher priority may not be picked up by the scanner.