Documentation
SiteDocs
Documentation Generation

Documentation Generation


Generating Docs

Go to Tools → SiteDocs → Documentation and click Generate Documentation (it reads Regenerate Documentation once docs exist). SiteDocs scans the site, then asks your AI connector to write each section.

Each section is written as 3–5 sentences of plain prose for a non-technical reader - no headings or bullet points. The whole set is saved once all sections are written, and the header shows Last generated with the section count.

Clear Documentation deletes all generated content and the last-regeneration diff.

Keeping Your Edits

Next to Regenerate Documentation there's a Keep my edited sections checkbox (ticked by default). With it ticked, sections you edited by hand - including their translations - are kept exactly as they are, and no AI request is made for them. Every other section is rewritten. Untick it to have the AI rewrite edited sections too.

Automatic regenerations (Auto-Update on Change) always keep edited sections. Video links and developer notes are always kept, because they are stored separately.

Translations of sections you didn't edit are removed on regeneration, because their text changes. Translate them again afterwards.


Section Types

SectionCreated forBadge
Custom post typeEach public custom post typeCPT
ACF field groupEach ACF field groupACF
Settings pageEach Settings API screenSETTINGS
WooCommerce Store SettingsThe store, when the WooCommerce module is onWOOCOMMERCE
Brand Style GuideWhen colours, fonts or a logo are detectedBRAND
Server EnvironmentAlwaysENVIRONMENT
External Integrations & API ConnectionsWhen integrations are detectedINTEGRATIONS

Editing a Section

Open the editor

Click Edit on the section.

Make your changes

Change the text as needed.

Save

Click Save. The section gets an Edited badge and the change is logged in the Changelog.


Per-Section Tools

Each section also has three icon buttons:

ButtonPurpose
▶ VideoAttach a walkthrough video - see Video Links
🌐 TranslateTranslate the section with AI - see Translation
🔒 Developer noteAdd a private note for administrators - see Developer Notes

If a Support URL is set, a support button with your label appears below the documentation.