[docs-scanner] Wasm documentation scope conflicts with deprecation status

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#26,614 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ó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
72/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
docker, markdown
Lĩnh vực
content, documentation

Hướng nghiên cứu

Đọc content/manuals/desktop/features/wasm.md và kiểm tra xem thông báo ngừng hỗ trợ phù hợp như thế nào với các phần thiết lập, ví dụ, hướng dẫn và khắc phục sự cố. Dựa trên thông tin hiện tại của dự án, hãy chọn một hướng rõ ràng cho trang, chẳng hạn như giảm hướng dẫn sử dụng hoặc bổ sung hướng dẫn di chuyển. Hoàn thành khi trang cung cấp cho người đọc hướng dẫn nhất quán về trạng thái của Wasm và việc cần làm.

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

Mô tả

File: content/manuals/desktop/features/wasm.md

Issue

The page opens with a clear deprecation notice:

Wasm workloads are deprecated and will be removed in a future Docker Desktop release. This feature is no longer actively maintained.

However, the rest of the page provides extensive, detailed instructions for enabling and using Wasm workloads, including:

  • Complete setup instructions ("Turn on Wasm workloads")
  • Multiple usage examples with docker run and Docker Compose
  • A multi-service application tutorial with step-by-step instructions
  • Building and pushing Wasm modules
  • Detailed troubleshooting section
Why this matters

A reader encountering this page faces conflicting signals:

  1. The deprecation notice suggests they should not invest time in this feature
  2. The comprehensive documentation (setup, examples, tutorials, troubleshooting) suggests this is a fully-supported feature worth learning

This creates confusion about whether users should:

  • Ignore the feature entirely (suggested by deprecation)
  • Learn and use it (suggested by the extensive documentation)
  • Migrate away from it (not addressed)
Suggested fix

Given the deprecation status, consider one of these approaches:

Option 1: Minimal documentation

  • Keep only the deprecation notice and basic description
  • Remove detailed setup, usage examples, and troubleshooting
  • Add a brief note about what users should use instead (if applicable)

Option 2: Migration-focused documentation

  • Keep the deprecation notice prominent
  • Add a section explaining migration path or alternatives
  • Reduce the emphasis on setup/usage and increase emphasis on "if you're currently using this, here's what to do"

Option 3: Clarify the timeline

  • If the feature will remain available for a significant period, clarify this in the deprecation notice
  • Example: "Wasm workloads are deprecated and will be removed in Docker Desktop 5.0 (estimated Q2 2025). This feature is no longer actively maintained but remains available for existing users."

The current approach of "deprecated but here's how to use it extensively" sends mixed messages to readers.

Found by nightly documentation quality scanner

Ngôn ngữ chính
Markdown
Star
4.7k
Fork
8.5k
Merge trung bình
2 ngày 10 giờ
Pull request đã merge (30 ngày)
139

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 docker/docs

Tất cả issue của docker/docs

Issue tương tự

Thêm issue về Content

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.