Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Interactive Demo Links to WordPress Block Editor Documentation #871

Closed
dionysous opened this issue Jun 8, 2023 · 3 comments
Closed
Assignees
Labels
block editor Gutenberg related issues [Status] Done Issue is completed user documentation (HelpHub) Improvements or additions to end-user documentation

Comments

@dionysous
Copy link

Issue Description

The WordPress Block Editor documentation could benefit from integrated interactive demo links (wordpress.org/gutenberg) to provide an enhanced user learning experience.

URL of the Page with the Issue

wordpress.org/documentation/article/wordpress-block-editor

Section of Page with the issue

Several sections: Introduction, Explanation of Blocks, 'Block Editor’s workspace' section, and Conclusion.

Why is this a problem?

Currently, readers only have text-based instructions and screenshots. Interactive demo links offer an immersive learning experience, allowing users to apply their learning in a practical environment.

Suggested Fix

Integrate "Try Block Editor Now" links in the following sections (or at least one time):

  1. After the introduction of the WordPress Block Editor.
  2. Post explanation of what blocks are.
  3. In the 'Block Editor’s workspace' section, after explaining how to launch the editor.
  4. At the conclusion of the article.

This would provide readers with immediate hands-on experience at each stage of the Block Editor process, thereby enhancing understanding and retention.

@dionysous dionysous added the tracking issue Use to track a series of related issues. label Jun 8, 2023
@zzap
Copy link
Member

zzap commented Jun 8, 2023

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

@zzap zzap added user documentation (HelpHub) Improvements or additions to end-user documentation block editor Gutenberg related issues and removed tracking issue Use to track a series of related issues. labels Jun 13, 2023
@github-actions
Copy link

Heads up @femkreations - the "block editor" label was applied to this issue.

@Leonardus-Nugraha Leonardus-Nugraha self-assigned this Jun 13, 2023
@zzap zzap mentioned this issue Jun 13, 2023
16 tasks
@Leonardus-Nugraha
Copy link
Collaborator

I've added links to the Gutenberg demo website in the intro, at the end of the "top toolbar" section, and the end of the article. I spread it that way so they're not too clustered together and repetitive. Plus, I use a highlight box, so they should capture readers attention.

@github-actions github-actions bot added the [Status] Done Issue is completed label Jun 27, 2023
@zzap zzap mentioned this issue Aug 8, 2023
20 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
block editor Gutenberg related issues [Status] Done Issue is completed user documentation (HelpHub) Improvements or additions to end-user documentation
Projects
None yet
Development

No branches or pull requests

4 participants