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: fix missing link to primitives package #46290

Merged
merged 1 commit into from
Dec 5, 2022

Conversation

t-hamano
Copy link
Contributor

@t-hamano t-hamano commented Dec 4, 2022

Fix #45804

What?

This PR fixes missing links to the primitives package, which is linked from within the following two documents. When you click on the 'wp.primitives.SVG' or 'wp.primitives.SVG component' link, you will see that the page is missing.

According to the documentation about using links, in order for the link to work in all contexts (handbook, GitHub repo, npm website), certain rules must be followed to describe the path.

  • /docs/*.md
  • /packages/*/README.md
  • /packages/components/src/**/README.md

Testing Instructions

Access the following readme file in this branch:

Confirm that the expected readme file is displayed when you click on 'wp.primitives.SVG' or 'wp.primitives.SVG component'. And this should work correctly with other contexts as well.

@t-hamano t-hamano marked this pull request as ready for review December 4, 2022 02:58
@t-hamano t-hamano self-assigned this Dec 4, 2022
@t-hamano t-hamano added the [Type] Developer Documentation Documentation for developers label Dec 4, 2022
Copy link
Contributor

@alexstine alexstine left a comment

Choose a reason for hiding this comment

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

@t-hamano LGTM.

@t-hamano
Copy link
Contributor Author

t-hamano commented Dec 5, 2022

Thank you, @alexstine!

@t-hamano t-hamano merged commit c4e1057 into trunk Dec 5, 2022
@t-hamano t-hamano deleted the doc/fix-missing-primitives-link branch December 5, 2022 06:05
@github-actions github-actions bot added this to the Gutenberg 14.8 milestone Dec 5, 2022
mpkelly pushed a commit to mpkelly/gutenberg that referenced this pull request Dec 7, 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.

Docs: Missing link to SVG primitive
2 participants