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

Docs: Update the Block Metadata title #40482

Merged
merged 3 commits into from
Apr 23, 2022
Merged

Docs: Update the Block Metadata title #40482

merged 3 commits into from
Apr 23, 2022

Conversation

aurooba
Copy link
Member

@aurooba aurooba commented Apr 20, 2022

What?

This PR updates the title of the Block Metadata page in the Block Editor handbook to include the term block.json in it.

Why?

While Metadata may seem like an obvious title for folks who already know what how it's incorporated into block development, for folks who may be new to block development, it can be a new way of thinking/paradigm.

How?

Adding block.json to the title makes the document easier to find and identify for folks who may be new to block development and not yet familiar with all the terminology. It would also be good for folks using search engines to find relevant information. :)

Adding `block.json` to the title makes the document easier to find and identify for folks who may be new to block development and not yet familiar with all the terminology. It would also be good for folks using search engines to find relevant information. :)
@gziolo
Copy link
Member

gziolo commented Apr 21, 2022

One more thing and we are good to go:

npm run docs:build

This will update the manifest file for Block Editor Handbook to use the new page title. If I recall correctly, this should impact also the sidebar link.

@gziolo gziolo added the [Type] Developer Documentation Documentation for developers label Apr 21, 2022
@gziolo gziolo changed the title Update the Block Metadata title Docs: Update the Block Metadata title Apr 21, 2022
@aurooba
Copy link
Member Author

aurooba commented Apr 23, 2022

@gziolo thanks for letting me know. I didn't know that was necessary! I ran npm run docs:build and it updated manifest.json. Let me know if there's something else I also need to run. Is this documented somewhere?

Copy link
Member

@gziolo gziolo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All good, thank you 💯

@gziolo gziolo merged commit 60bddd3 into WordPress:trunk Apr 23, 2022
@github-actions github-actions bot added this to the Gutenberg 13.2 milestone Apr 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants