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

[HelpHub]: Paragraph Block #978

Open
7 tasks
femkreations opened this issue Jul 17, 2023 · 16 comments
Open
7 tasks

[HelpHub]: Paragraph Block #978

femkreations opened this issue Jul 17, 2023 · 16 comments
Assignees
Labels
6.3 Changes in 6.3 release good first issue Good for newcomers high priority [Status] In progress Issue is in progress tracking issue Use to track a series of related issues. user documentation (HelpHub) Improvements or additions to end-user documentation

Comments

@femkreations
Copy link
Collaborator

Article: https://wordpress.org/documentation/article/paragraph-block/

Update for 6.3

  • Footnotes: try with post meta 51201

General

  • Make sure all screenshots are relevant to the latest version
  • Make sure videos, if any, are up to date
  • Add ALT tags for the images
  • Make sure the headings are in sentence case
  • Convert all reusable blocks to a ‘regular block’.
  • Update the changelog at the end of the article

Notes

  1. We are not adding detailed updates for the Block settings - Typography, Color, Layout, Dimension and Border and for the More Options setting in the block toolbar. Pls mention the settings included for the block and link to the detailed settings pages instead.
  2. Some of the PRs have great videos that can be added to the article.
@femkreations femkreations added user documentation (HelpHub) Improvements or additions to end-user documentation [Status] To do Issue marked as Todo 6.3 Changes in 6.3 release labels Jul 17, 2023
@huzaifaalmesbah
Copy link

good work

@NewYorkerLaura
Copy link

@femkreations I can take this one on for 6.3

@femkreations femkreations moved this from Todo to In Progress in WP 6.3 Documentation Jul 21, 2023
@github-actions github-actions bot added [Status] In progress Issue is in progress and removed [Status] To do Issue marked as Todo labels Jul 21, 2023
@Leonardus-Nugraha Leonardus-Nugraha added the tracking issue Use to track a series of related issues. label Jul 25, 2023
@Zebedeu
Copy link

Zebedeu commented Aug 16, 2023

@femkreations I will work on it in case someone is not working.

@Zebedeu
Copy link

Zebedeu commented Aug 21, 2023

@zzap is anyone currently working on this?

@zzap
Copy link
Member

zzap commented Aug 21, 2023

Looks like not. You can take it

@zzap zzap assigned Zebedeu and unassigned NewYorkerLaura Aug 21, 2023
@Zebedeu
Copy link

Zebedeu commented Aug 22, 2023

Instead of the icon, the existing video in the article contains the text Preview.

Image

@Zebedeu
Copy link

Zebedeu commented Aug 28, 2023

  • Make sure all screenshots are relevant to the latest version
  • Make sure videos, if any, are up to date
  • Add ALT tags for the images
  • Make sure the headings are in sentence case
  • Convert all reusable blocks to a ‘regular block’.
  • Update the changelog at the end of the article

The points 3, 4, and 5 are already in compliance.

@Zebedeu
Copy link

Zebedeu commented Aug 28, 2023

In the following paragraph, it was not mentioned whether the mentioned shortcuts are for MAC or Windows: "The Paragraph block also supports keyboard shortcuts for text formatting, making creating and customizing content easier. For example, you can convert texts into headings using keyboard shortcuts: Alt + Shift + Number 1-6. The numerical keyboard shortcuts represent Heading 1 to Heading 6. If you want to change them back to texts, press Alt + Shift + 0."

@Zebedeu
Copy link

Zebedeu commented Aug 29, 2023

My video proposal

Untitled.1.mp4

@zzap
Copy link
Member

zzap commented Oct 2, 2023

@docs-reviewers, this is ready for /review

@github-actions github-actions bot added [Status] Review Issue in review and removed [Status] In progress Issue is in progress labels Oct 2, 2023
@shawnco
Copy link

shawnco commented Apr 9, 2024

I'm down to review this

@shawnco
Copy link

shawnco commented Apr 20, 2024

Findings:

The article has a long GIF showing how to use the paragraph block. Would it make more sense for this to be a video? That way readers can re-watch parts they miss, skip parts, etc.

The first image under "Block settings" is outdated

Additionally, you can add links, inline images, and highlight to the text content.

Should this be "highlights" (plural)?

The paragraph block provides dimension settings options

Should this say Paragraph to be consistent?

The “Advanced” tab lets you add HTML anchor

The quotes around Advanced isn't consistent with how other sections of that menu are referenced

@Leonardus-Nugraha Leonardus-Nugraha moved this from In Progress to Needs 1st Review in WP 6.3 Documentation Apr 23, 2024
@sagargurnani99
Copy link
Collaborator

@Zebedeu this issue is done with the 1st review. Please make changes as per the suggestions by the reviewer.

@sagargurnani99 sagargurnani99 added [Status] In progress Issue is in progress and removed [Status] Review Issue in review labels May 14, 2024
@Zebedeu
Copy link

Zebedeu commented May 14, 2024

@sagargurnani99 Yes. I can do that.

@Zebedeu
Copy link

Zebedeu commented May 14, 2024

Descobertas:

O artigo traz um longo GIF mostrando como usar o bloco de parágrafo. Faria mais sentido se fosse um vídeo? Dessa forma, os leitores podem assistir novamente às partes que perderam, pular partes, etc.

A primeira imagem em "Configurações de bloqueio" está desatualizada

Além disso, você pode adicionar links, imagens embutidas e realçar o conteúdo do texto.

Deveriam ser "destaques" (plural)?

O bloco de parágrafo fornece opções de configurações de dimensão

Isso deveria dizer que o parágrafo é consistente?

A guia “Avançado” permite adicionar âncora HTML

As aspas em torno de Avançado não são consistentes com a forma como outras seções desse menu são referenciadas

@shawnco "The paragraph block provides various options to adjust its dimensions, such as width and height, allowing you to customize the text layout to ensure visual consistency." Do you agree with this explanation?

@Zebedeu
Copy link

Zebedeu commented May 15, 2024

@sagargurnani99 Updates have been made according to all revisions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
6.3 Changes in 6.3 release good first issue Good for newcomers high priority [Status] In progress Issue is in progress tracking issue Use to track a series of related issues. user documentation (HelpHub) Improvements or additions to end-user documentation
Projects
Status: Needs 1st Review
Development

No branches or pull requests

9 participants