[HelpHub] Shortcode block screenshots

Open Beginner friendly
#791 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
84/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
wordpress
Domain
documentation

Research direction

Open the shortcode block documentation page at wordpress.org/documentation/article/shortcode-block/ and inspect its screenshots. Replace the misleading screenshots that suggest iframe markup with screenshots showing an actual shortcode example, then verify the page no longer gives the incorrect impression.

Written by the indexing model from the issue text.

Description

[Block] Shortcode [Status] Review user documentation (HelpHub)

Issue Description

Screenshots for shortcode block suggest that <iframe> markup can be used inside the block. This is not correct and screenshots should show the example of adding shortcode.

URL of the Page with the Issue

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

Section of Page with the issue

Why is this a problem?

Because it's misleading.

Suggested Fix

Change screenshots to show the actual shortcode being used inside shortcode block.

Dominant language
Shell
Stars
109
Forks
73
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from WordPress/Documentation-Issue-Tracker

All issues in WordPress/Documentation-Issue-Tracker

Similar issues

More Shell/Bash issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.