Each built-in automation sits in one of five tabs: Accuracy, SEO and GEO, Content gaps, Knowledge base, and Releases and reports. To turn one on, see Automations.
| Setting | Default |
|---|
| Agent | Docs Agent, for every automation |
| Time | 9:00 AM in your browser’s time zone |
| Weekly schedule | Every week on Monday |
| Monthly schedule | Every month on day 1 |
| Send a Slack notification | Checked for every template |
| Raise a pull request | Checked, except for Pylon Support Review, Improve Pylon knowledge base, Confluence Knowledge Base Drift Review, Release Marketing Brief and EkLine Work Report |
| Inputs | Every input is required. Fill in an empty one before the automation can turn on. You can change a prefilled value. |
| Automation | What it does | Default schedule | Inputs |
|---|
| Docs Drift Review | Finds recent GitHub changes that customers would notice but the docs miss, then fixes the most important gap. | Weekly, Monday | Lookback window: starts empty, so enter a period such as last 30 days |
| Code Sample Review | Checks that code samples in the docs work with the APIs and SDKs they show, then opens a PR that fixes them. | Weekly, Monday | None |
| Doc UI Accuracy Review | Checks that the docs match the app’s labels, menus and layout, then opens a PR that fixes what changed. | Weekly, Monday | None |
| Doc Screenshot Refresh | Compares doc screenshots with the live product, then retakes old ones and adds missing ones, up to 5 images a run. | Weekly, Monday | Sandbox name(s) to screenshot against (one per line): starts empty. See Sandbox. |
| README Review | Checks README.md against the code and fixes wrong install steps, dependencies, settings, examples or API references. | Weekly, Monday | Repository name: starts empty |
| Automation | What it does | Default schedule | Inputs |
|---|
| Docs SEO Review | Checks page titles, descriptions, headings and links against your marketing keywords, then fixes the issue that matters most. | Weekly, Monday | Your company marketing website URL: starts empty |
| FAQ Structured Data | Adds or fixes FAQPage JSON-LD on FAQ pages so search engines can show rich results, up to 5 files a run. | Weekly, Monday | None |
| JSON-LD Entity Graph | Adds linked JSON-LD for your company, site, product, pages and breadcrumbs, so answer engines read how you describe yourself. | Monthly, day 1 | Your company marketing website URL: starts empty |
| Image Alt Audit | Finds doc images with missing or weak alt text and fixes up to 20 a run. | Weekly, Monday | None |
| Automation | What it does | Default schedule | Inputs |
|---|
| Tutorial Gap Review | Studies the product, its readers and competitors’ docs to find the missing tutorial or how-to that matters most, then writes it. | Monthly, day 1 | None |
| Persona IA Review | Reads the docs as your typical readers would, then fixes the biggest problem in how the docs are laid out for them. | Monthly, day 1 | None |
| Automation | What it does | Default schedule | Inputs |
|---|
| Pylon Support Review | Groups recent Pylon tickets by theme into a ranked report of docs gaps, sent where you choose or in Slack. Then it fixes the top 2. | Weekly, Monday | Time window: starts empty, for example last 30 days. What to do with the report: starts empty, for example post to Slack channel #docs-team, or inline to deliver it in Slack only. |
| Improve Pylon knowledge base | Finds recent Pylon tickets the help center should have answered, and drafts the missing or fixed articles. | Weekly, Monday | Time window: prefilled last 7 days |
| Confluence Knowledge Base Drift Review | Finds Confluence pages that recent docs changes made out of date, then drafts fixes for review. | Monthly, day 1 | Time window: prefilled last 30 days |
| Automation | What it does | Default schedule | Inputs |
|---|
| Release Notes Generator | Writes release notes from tickets and GitHub activity since the last release notes. | Weekly, Monday | None |
| Release Marketing Brief | Drafts a Slack-ready brief of the main features customers got in the last 7 days, for your marketing and support teams. | Weekly, Monday | Lookback window: prefilled last 7 days |
| EkLine Work Report | Reports the last 7 days of EkLine docs work across your docs repos: what shipped, what is waiting, and who each open PR waits on. | Weekly, Monday | Time window: prefilled last 7 days |
To see what the work report and the release brief hold, and how to send them to Slack, see Keep your team informed.
