search

WordPress / Documentation-Issue-Tracker

Issue Tracker for the WordPress Documentation team.
https://make.wordpress.org/docs/
Other
80 stars 41 forks source link

[HelpHub] Feedback on Cover block #1700

Open zzap opened 2 weeks ago

zzap commented 2 weeks ago

URL of the Page with the Issue

https://wordpress.org/documentation/article/cover-block/

Originally reported by

https://profiles.wordpress.org/keyurdave/

Report content (issue description)

The feedback below would make the article more comprehensive, accessible, and beneficial for both beginners and advanced users.

  1. Add More Visual Aids and Examples

Feedback: The documentation lacks sufficient visual aids or step-by-step examples. While there are a few images, more contextual screenshots, GIFs, or video walkthroughs could help users understand the different functionalities.

Suggestion: Include interactive GIFs or short videos showing users how to change background images, use the block toolbar, and adjust settings like the toggle for full-height mode or content positioning. This will make it more beginner-friendly and engaging.

  1. Detailed Explanation of Advanced Tab Features

Feedback: The section on the Advanced Tab (HTML anchor, semantic elements, and additional CSS classes) is a bit too basic, especially for users who may not fully understand the importance or practical application of these features.

Suggestion: Provide real-world use cases for each feature. For example, explain when and why someone would use the element versus , or provide an example of a specific CSS class and how it alters the appearance of the Cover Block. You could also add a section showing how to create and link to HTML anchors, making it easier for users to understand.

  1. Expand the Section on Media Options for Cover Block

Feedback: The section discussing using images and video backgrounds is limited in scope. With the WordPress 6.6 update, additional capabilities have been introduced that could be highlighted.

Suggestion: Add information about lazy loading for media files, recommended video formats (like WebP or MP4), and how the Cover Block handles responsive media across devices. Also, more guidance should be included on optimizing videos and images for performance without sacrificing quality.

  1. Clarify Full-Site Editing (FSE) Integration

Feedback: There’s no clear information on how the Cover Block can be integrated into the Full-Site Editing (FSE) experience, especially for users with block-based themes.

Suggestion: Add a section explaining how the Cover Block behaves within site-wide templates like headers or footers in block-based themes, particularly focusing on the block’s flexibility and reusability when designing full-site layouts.

  1. Accessibility Best Practices

Feedback: While the block’s basic functionality is explained, there is no emphasis on accessibility, which is crucial for many users.

Suggestion: Include a small section or tips on ensuring accessibility when using the Cover Block, such as choosing the correct semantic HTML elements, ensuring contrast between text and background images, and optimizing video backgrounds for people with disabilities.

Section of Page with the issue

Why is this a problem?

Suggested Fix

github-actions[bot] commented 2 weeks ago

Heads up @WordPress/docs-issues-coordinators, we have a new issue open. Time to use 'em labels.