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

fix: update block category to design and build documentation. #61905

Merged
merged 2 commits into from
Jun 19, 2024

Conversation

snehapatil2001
Copy link
Contributor

Issue: #60930

Description

Issue

The experimental Table of Contents block in the Gutenberg repository is using the category "layout" in its block.json file. However, "layout" is not listed as a valid block category according to the block.json schema. The valid categories are:

  • "text"
  • "media"
  • "design"
  • "widgets"
  • "theme"
  • "embed"

Solution

This PR resolves the issue by changing the category of the Table of Contents block from "layout" to "design", which is one of the valid categories listed in the schema. This ensures that the block complies with the schema and avoids any validation issues.

Changes

  • Updated the block.json file for the experimental Table of Contents block to change the category from "layout" to "design".
  • Build Documentation.

Tests

  • Verified that the block appears correctly under the "design" category in the block inserter.
  • Checked that the block functions as expected without any validation errors.
Copy link

github-actions bot commented May 23, 2024

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: snehapatil2001 <snehapatil02@git.wordpress.org>
Co-authored-by: fabiankaegy <fabiankaegy@git.wordpress.org>
Co-authored-by: akasunil <sunil25393@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@github-actions github-actions bot added the First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository label May 23, 2024
Copy link

👋 Thanks for your first Pull Request and for helping build the future of Gutenberg and WordPress, @snehapatil2001! In case you missed it, we'd love to have you join us in our Slack community.

If you want to learn more about WordPress development in general, check out the Core Handbook full of helpful information.

@fabiankaegy fabiankaegy added [Type] Enhancement A suggestion for improvement. [Block] Table of contents (experimental) Affects the Table of contents Block labels May 23, 2024
Copy link
Member

@fabiankaegy fabiankaegy left a comment

Choose a reason for hiding this comment

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

Great catch. Thanks for the fix :)

@snehapatil2001
Copy link
Contributor Author

@fabiankaegy Do I have to make any more changes or is it good to be merged??

@akasunil
Copy link
Member

akasunil commented Jun 19, 2024

@snehapatil2001 Yes, it ready for merge once all checks are passed. I see some tests are still pending, Can you sync with trunk? that might resolve it.

@snehapatil2001
Copy link
Contributor Author

@akasunil Synced up with trunk.

@akasunil akasunil merged commit a1f7c07 into WordPress:trunk Jun 19, 2024
58 checks passed
@github-actions github-actions bot added this to the Gutenberg 18.7 milestone Jun 19, 2024
@t-hamano
Copy link
Contributor

Hi @akasunil,

When you merge the pull request, please paste the props mentioned in this comment into the commit message.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Block] Table of contents (experimental) Affects the Table of contents Block First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository [Type] Enhancement A suggestion for improvement.
4 participants