-
Notifications
You must be signed in to change notification settings - Fork 4.2k
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 all local links in README files to work with npm #13030
Conversation
I noticed some inconistent new lines added in |
@@ -1,6 +1,6 @@ | |||
# MenuItem | |||
|
|||
MenuItem is a component which renders a button intended to be used in combination with the [DropdownMenu component](../dropdown-menu). | |||
MenuItem is a component which renders a button intended to be used in combination with the [DropdownMenu component](/packages/components/src/dropdown-menu/README.md). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just noticed that the components links included /src/
which wasn't originally covered in #12835 - https://meta.trac.wordpress.org/changeset/7998 should cover that case too :)
@dd32, I update all links that wouldn't work. I went too far with updates :) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍
Seems like it would be good to add a note to https://github.com/WordPress/gutenberg/blob/master/CONTRIBUTING.md#contribute-to-the-documentation
On adding links to docs.
Once we confirm it works everywhere as we anticipate, we definitely should 😃 Are there any Markdown linters? |
yes, we have many options we can zero down on one to cut down formatting reviews and bring in some consistency across docs. https://github.com/markdownlint/markdownlint |
@chrisvanpatten thanks for linking this was trying to recollect the same 👍 |
* Docs: Update all local links in README files to work with npm * Update packages/blocks/README.md * Fix new lines in blocks README file * Revert nux component link * Revert link to the block library * Update link to component from edit-post package
* Docs: Update all local links in README files to work with npm * Update packages/blocks/README.md * Fix new lines in blocks README file * Revert nux component link * Revert link to the block library * Update link to component from edit-post package
Description
This is a follow-up for #12835 where we discussed updating local link in README files to work with GitHub, npm and Gutenberg handbook. Thanks to changes introduced in https://meta.trac.wordpress.org/changeset/7989 and https://meta.trac.wordpress.org/changeset/7993 by @dd32, we are now able to use absolute GitHub paths to work universally in all 3 platforms 🎉
All urls in
/packages
folder were updated to avoid directory traversing.