Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Add a browser-level layout test for the API examples column

Đang mở
  • Có gì không ổn?
#4,555 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
55/100
Loại issue
Tính năng
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
csharp, playwright
Lĩnh vực
testing

Hướng nghiên cứu

Start by reading the existing visual harness in src/Elastic.Documentation.Site/visual/ and the test setup behind npm run test; those tests use JSDOM and cannot measure layout. Add a Playwright test that loads a fixed local API spec with long request and response examples in both layouts at short and tall window heights. Done means both code blocks keep nonzero, stable heights and the response can be reached by scrolling.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

enhancement needs triage user-experience

The API examples column has no automated test that checks its layout, so a window-height bug like the one fixed in #4554 can come back with every check green.

What is getting in your way

npm run test runs in JSDOM, which does no layout. It cannot see a request code block that collapses to zero height or a response pushed out of view. The visual harness in src/Elastic.Documentation.Site/visual/ compares screenshots against seeded baselines. It does not assert block heights or reachability, and the API pages it loads build from specs fetched at run time.

What would you like instead

A Playwright test that opens an API operation with a long request example and a long response example. It runs at a short and a tall window height, in the legacy and the design-system layouts. It asserts that each code block has a nonzero height that stays the same across window heights, and that the response is reachable by scrolling the page. The operation needs a fixed local spec, so the example lengths do not change between runs.

Anything else

Raised in review on #4554 by an automated reviewer.

Ngôn ngữ chính
C#
Star
25
Fork
45
Merge trung bình
17 giờ 9 phút
Pull request đã merge (30 ngày)
292

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của elastic/docs-builder

Tất cả issue của elastic/docs-builder

Issue tương tự

Thêm issue về C#

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.