Skip to content

Docs: Update RichTextToolbarButton link in docs #70804

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Jul 21, 2025
Merged

Docs: Update RichTextToolbarButton link in docs #70804

merged 2 commits into from
Jul 21, 2025

Conversation

Infinite-Null
Copy link
Contributor

@Infinite-Null Infinite-Null commented Jul 20, 2025 •
edited
Loading

What?

Closes #70802

Fix broken RichTextToolbarButton documentation link in Format API guide.

Why?

The Format API guide contains a broken link to RichTextToolbarButton documentation that returns a 404 error, leaving developers without proper reference material. The current link points to /packages/block-editor/src/components/rich-text#richtexttoolbarbutton which doesn't exist, causing confusion for developers trying to follow the guide.

How?

  • Fixed broken documentation link: Updated the RichTextToolbarButton reference in the "Additional resources" section from the non-existent /packages/block-editor/src/components/rich-text#richtexttoolbarbutton to the correct working documentation URL /packages/editor/README.md#richtexttoolbarbutton

@Infinite-Null Infinite-Null marked this pull request as ready for review July 21, 2025 06:44
@github-actions GitHub Actions
Copy link

Warning: Type of PR label mismatch

To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.

  • Type-related labels to choose from: [Type] Automated Testing, [Type] Breaking Change, [Type] Bug, [Type] Build Tooling, [Type] Code Quality, [Type] Copy, [Type] Developer Documentation, [Type] Enhancement, [Type] Experimental, [Type] Feature, [Type] New API, [Type] Task, [Type] Technical Prototype, [Type] Performance, [Type] Project Management, [Type] Regression, [Type] Security, [Type] WP Core Ticket, Backport from WordPress Core, Gutenberg Plugin.
  • Labels found: .

Read more about Type labels in Gutenberg. Don't worry if you don't have the required permissions to add labels; the PR reviewer should be able to help with the task.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jul 21, 2025 •
edited
Loading

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: Infinite-Null <ankitkumarshah@git.wordpress.org>
Co-authored-by: fabiankaegy <fabiankaegy@git.wordpress.org>
Co-authored-by: atachibana <atachibana@git.wordpress.org>

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

@t-hamano t-hamano added the [Type] Developer Documentation Documentation for developers label Jul 21, 2025
fabiankaegy
fabiankaegy reviewed Jul 21, 2025
View reviewed changes
docs/how-to-guides/format-api.md Outdated
@@ -225,7 +225,7 @@ If you run into errors:
Reference documentation used in this guide:

- RichText: [`registerFormatType`](/packages/rich-text/README.md#registerformattype)
- Components: [`RichTextToolbarButton`](/packages/block-editor/src/components/rich-text#richtexttoolbarbutton)
- Components: [`RichTextToolbarButton`](/packages/editor/README.md#richtexttoolbarbutton)
Copy link
Member

Choose a reason for hiding this comment

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

We should use the version of there readme in the @wordpress/block-editor package instead since the one in @wordpress/editor is deprecated

Suggested change
- Components: [`RichTextToolbarButton`](/packages/editor/README.md#richtexttoolbarbutton)
- Components: [`RichTextToolbarButton`](/packages/block-editor/README.md#richtexttoolbarbutton)

@Infinite-Null
Copy link
Contributor Author

Infinite-Null commented Jul 21, 2025 •
edited
Loading

Hi @fabiankaegy,
Thank you for the feedback 🙌. I have updated the PR please review it at your convenience.

@fabiankaegy fabiankaegy merged commit 415367c into WordPress:trunk Jul 21, 2025
42 of 60 checks passed
@github-actions github-actions bot added this to the Gutenberg 21.3 milestone Jul 21, 2025
adamsilverstein pushed a commit to adamsilverstein/gutenberg that referenced this pull request Jul 21, 2025
@Infinite-Null @fabiankaegy @adamsilverstein
Docs: Update RichTextToolbarButton link in docs (WordPress#70804)
be2e444 
Co-authored-by: Infinite-Null <ankitkumarshah@git.wordpress.org>
Co-authored-by: fabiankaegy <fabiankaegy@git.wordpress.org>
Co-authored-by: atachibana <atachibana@git.wordpress.org>
USERSATOSHI pushed a commit to USERSATOSHI/gutenberg that referenced this pull request Jul 23, 2025
@Infinite-Null @fabiankaegy @USERSATOSHI
Docs: Update RichTextToolbarButton link in docs (WordPress#70804)
17e7b25 
Co-authored-by: Infinite-Null <ankitkumarshah@git.wordpress.org>
Co-authored-by: fabiankaegy <fabiankaegy@git.wordpress.org>
Co-authored-by: atachibana <atachibana@git.wordpress.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fabiankaegy fabiankaegy fabiankaegy approved these changes

@ajitbohra ajitbohra Awaiting requested review from ajitbohra ajitbohra is a code owner

@juanmaguitar juanmaguitar Awaiting requested review from juanmaguitar juanmaguitar is a code owner

@ndiego ndiego Awaiting requested review from ndiego ndiego is a code owner

Assignees
No one assigned
Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Milestone
Gutenberg 21.3
Development

Successfully merging this pull request may close these issues.

404 on RichTextToolbarButton documentation page
3 participants
@Infinite-Null @fabiankaegy @t-hamano