Home CodeDoc How do I add an automation to run documentation automatically?

How do I add an automation to run documentation automatically?

Last updated on Nov 10, 2025

Short Answer: Open the Automation tab, click "Add automation", complete the automation dialog, and save; the new automation will appear in the automations list.

Prerequisites

  1. Repository and branch connected in CodeDoc

  2. Permission to create automations

Steps

  1. Go to the Automation tab in CodeDoc.
    Automation list and controls are visible.

  2. Click the "Add automation" button to open the automation dialog.
    The "Add automation" dialog appears.

  3. Complete the required fields in the dialog (select repository, branch and define the trigger/conditions shown).
    All required fields are filled and the primary save button becomes active.

  4. Click the dialog’s primary button to save the automation.
    The new automation appears in the automation list and can be toggled ON/OFF.

Troubleshooting

  1. "Add automation" button is unresponsive or the dialog save button is disabled.
    LikelyCause: Required fields are missing or you lack permission to create automations.
    Action: Fill all required fields in the dialog and check your account permissions; contact an Admin/Owner if needed.

  2. Automation does not trigger as expected.
    LikelyCause: Automation toggle may be OFF, or trigger/conditions target a branch with no new activity.
    Action: Open Automation tab, ensure the automation is toggled ON and verify trigger settings and target branch.

Note: Automation UI shows the trigger/condition configuration in the dialog; saved automations can be edited from the Automation list.