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: Invalid link on explanations documentation. #62487

Merged

Conversation

jorgefilipecosta
Copy link
Member

The section "What’s the difference between the different editor packages? What’s the purpose of each package?" does not exist anymore but the link to it was kept.
This PR removes the invalid link.

Copy link

github-actions bot commented Jun 11, 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: jorgefilipecosta <[email protected]>
Co-authored-by: t-hamano <[email protected]>

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

@t-hamano
Copy link
Contributor

The section itself seems to exist.

https://developer.wordpress.org/block-editor/explanations/architecture/modularity/#whats-the-difference-between-the-different-editor-packages-whats-the-purpose-of-each-package

However, when I click on this link on the Explanations page, I go to the following URL and the page is not found.

https://developer.wordpress.org/block-editor/explanations/architecture/modularity.md/#whats-the-difference-between-the-different-editor-packages-whats-the-purpose-of-each-package

Perhaps if we remove the slash after the extension (.md), it will link correctly. All other links do not have a slash after the extension.

diff --git a/docs/explanations/README.md b/docs/explanations/README.md
index 04d9f8e9e1..2d0da6cabd 100644
--- a/docs/explanations/README.md
+++ b/docs/explanations/README.md
@@ -8,5 +8,5 @@
 -   [Block Editor Performance](/docs/explanations/architecture/performance.md).
 -   What are the decision decisions behind the Data Module?
 -   [Why is Puppeteer the tool of choice for end-to-end tests?](/docs/explanations/architecture/automated-testing.md)
--   [What’s the difference between the different editor packages? What’s the purpose of each package?](/docs/explanations/architecture/modularity.md/#whats-the-difference-between-the-different-editor-packages-whats-the-purpose-of-each-package)
+-   [What’s the difference between the different editor packages? What’s the purpose of each package?](/docs/explanations/architecture/modularity.md#whats-the-difference-between-the-different-editor-packages-whats-the-purpose-of-each-package)

@jorgefilipecosta jorgefilipecosta force-pushed the remove/unexistent-section-from-explanations-documet branch 2 times, most recently from b8ad96d to 9f4cb6a Compare June 12, 2024 09:36
@jorgefilipecosta
Copy link
Member Author

You are totally right @t-hamano, I noticed the modularity.md file had changed but I missed that the section was still there at the bottom. I fixed the link as suggested.

@jorgefilipecosta jorgefilipecosta changed the title Docs: Remove inexistent section from the explanations document. Fix: Remove inexistent section from the explanations document. Jun 12, 2024
@jorgefilipecosta jorgefilipecosta changed the title Fix: Remove inexistent section from the explanations document. Fix: Invalid link on explanations documentation Jun 12, 2024
@jorgefilipecosta jorgefilipecosta changed the title Fix: Invalid link on explanations documentation Fix: Invalid link on explanations documentation. Jun 12, 2024
@t-hamano t-hamano self-requested a review June 12, 2024 10:57
Copy link
Contributor

@t-hamano t-hamano left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@jorgefilipecosta jorgefilipecosta merged commit e48e636 into trunk Jun 12, 2024
63 checks passed
@jorgefilipecosta jorgefilipecosta deleted the remove/unexistent-section-from-explanations-documet branch June 12, 2024 11:43
@github-actions github-actions bot added this to the Gutenberg 18.6 milestone Jun 12, 2024
patil-vipul pushed a commit to patil-vipul/gutenberg that referenced this pull request Jun 17, 2024
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