Skip to content

Add E2E Testing Methods section to block doc pages #2040

Description

@machielvdw

Brief

Problem

Block documentation pages don't show what e2e testing methods are available for each block. Users writing Playwright tests with ldf.block() have to read the source e2e.js files to discover available do (action) and expect (assertion) methods. This information should be part of the block's doc page.

Acceptance Criteria

  • Each block doc page with an e2e.js file shows an "E2E Testing Methods" section after the examples section
    • Displays available do methods (actions) and expect methods (assertions) in a table format
    • Table columns: method name, parameters, and description
  • The method data is sourced from the block's e2e.js file
    • Implementation approach (auto-generated via build-time transformer vs manually authored) is left to the developer to evaluate and decide
  • Blocks without e2e.js files show no section (no placeholder or "coming soon")
  • The section renders correctly on the docs site and is readable on both desktop and mobile

Related Work

Existing: Block doc template (packages/docs/templates/blocks/template.yaml.njk)
Existing: E2E testing docs (packages/docs/testing/)
Existing: Block e2e.js helpers (packages/plugins/blocks/blocks-antd/src/blocks/*/e2e.js)
Related: #2038 (e2e.js helpers for remaining blocks — once added, their docs should populate)

Source

Add to the Lowdefy docs site on each block its e2e utils definitions — what the ldf fixture can access on that block (what's defined in the e2e.js files). Auto-generated from e2e.js, shown as a table with method names, parameters, and descriptions.


Brief Agent - Created: 2026-03-10 12:45 CAT

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions