Documentation Generation
Generating Docs
After a scan, click Generate Documentation. SiteDocs sends the structured scan data to your configured AI provider, which returns markdown-formatted documentation for each section.
The generation is section-by-section. Each section is saved independently, so a failure in one section (e.g., API timeout) does not lose previously generated sections.
Click Clear Documentation to delete all generated content and start fresh.
Section Structure
Generated documentation is organised into sections. Default section types:
| Section | Contents |
|---|---|
| Site Overview | Site name, URL, WordPress version, theme, brief description |
| Custom Post Types | Each CPT with fields, capabilities, and usage context |
| ACF Field Groups | Each field group with all fields, types, and location rules |
| Plugin Configuration | Active plugins with purpose and key configuration |
| WooCommerce Setup | Store settings, payment gateways, shipping zones, products |
| Integrations | Plugin integrations and dependency map |
| Environment | PHP/MySQL/server details, defined constants |
| Changelog | Changes detected between scan versions |
Editing Generated Content
Each section has an Edit button that opens an inline markdown editor.
Open the editor
Click the Edit button on any section.
Make your changes
Edit the markdown content as needed.
Save the section
Click Save Section to preserve your changes.
Manual edits are preserved through subsequent auto-generations unless you click Regenerate Section.
Click Regenerate Section on any individual section to refresh just that section from the AI without clearing the rest of the documentation.