Skip to content

Docs-as-tests: automated Console UI drift detection #2671

Description

@marcel-rbro

What

Stand up automated detection of documentation drift between the platform docs and the Apify Console UI. UI claims in the docs — a route resolves, a tab/button is named X, a heading is visible on page Y — are extracted as testable assertions and verified against Console staging, so when the UI changes and the docs don't, we find out automatically.

Approach: an adjustable list of docs pages → assertions extracted with an LLM → stored as a committed, human-reviewed baseline → evaluated against staging with Playwright. Failures point back to source_file:line.

Status

Initial harness and a baseline for a 4-page Console test set (index, settings, billing, store — 53 assertions: routes, tabs, buttons, headings) are up in #2669.

Remaining work

  • Scale page coverage beyond the initial test set
  • Handle detail-page assertions that require seeded fixtures (Actor / task / schedule / storage detail)
  • Global left-nav group check (not a per-page claim)
  • Session-gated pages (e.g. re-auth-required settings)
  • Multi-step flow assertions (deferred — atomic claims first)
  • Wire a scheduled GitHub Action (modeled on lychee.yml), with all secrets in GitHub Secrets and nothing in .env

Source

Internal plan "AI-based testing for docs"; implementation tracked in #2669.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation.t-docsIssues owned by technical writing team.

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions