DOCUMENT OPS

Weekly README staleness audit with Linear tickets

Every Monday, scans your ReadMe guides for pages that mention endpoints no longer in your shipped API surface and opens a Linear issue per stale page so docs debt gets triaged…

CategoryDocument Ops
Enginesim
Difficultyintermediate
Triggerschedule
Steps6
Setup~15 min

How it runs

The automated pipeline, trigger to output.

  • TriggerEvery Monday at 9am
  • ActionList published guides from ReadMeReadMeReadMe
  • ActionPull live route inventory from GitHubGitHubGitHub
  • LogicFlag guides referencing dead endpoints
  • LogicSkip pages with an existing open issueLinearLinear
  • OutputOpen a Linear issue per stale pageLinearLinear

What it does

Runs a scheduled sweep of your ReadMe documentation, cross-references every code sample and endpoint reference against the live API surface pulled from GitHub, and turns each stale page into a tracked Linear issue with the specific mismatches listed.

When to use it

Use it when docs rot accumulates quietly and nobody owns cleanup. A weekly cadence keeps the audit lightweight while ensuring drift surfaces as actionable work rather than a once-a-year doc overhaul.

How it works

  1. 1A schedule trigger fires every Monday morning.
  2. 2The workflow pulls all published guides from ReadMe and the current route inventory from the GitHub repo.
  3. 3A logic step flags any guide referencing an endpoint, parameter, or method that no longer exists in the shipped surface.
  4. 4For each flagged guide it checks whether an open Linear issue already exists to avoid duplicates.
  5. 5It creates a Linear issue per newly stale page, labeled docs-drift, with the page URL and exact stale references in the description.

Set it up

What you configure once, before turning it on.

  1. 1
    Connect ReadMeAPI docs, changelog, auth.
  2. 2
    Connect GitHubRepos, issues, pull requests, actions.
  3. 3
    Connect LinearIssues, projects, cycles, triage.
  4. 4
    Set each agent's modelWe leave models unset so you pick the tier — fast + cheap, or top-quality.
  5. 5
    Tune it to your dataEdit the prompts, filters, and field mappings so it matches how your team works.
  6. 6
    Test, then turn it onRun once against a sample, confirm the output, then enable the trigger.

Run this workflow in your colony.

14-day trial. No DevOps. No Sales call. Provisioned in under a minute.