Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upUpdate permalinks.md #289
Update permalinks.md #289
Conversation
Included contributor-friendly information about permalinks
Why:
There's a linked reference to this page
CONTRIBUTING.md, which makes it a first stop when content contributors are looking for information about permalinks. While the current version of the page is technically accurate, it may be confusing especially for first-time contributors: failing to properly reference an internal link generates a "permalink" lint error during the PR automated testing. As a first-time contributor, it took me a couple of trials/patches to my original PR to get it right.I didn't open an issue related to this situation, but I thought it'd be useful to add extra information about it for content contributors.
What's being changed:
Added a paragraph at the end of the document explaining how internal links should be referenced (and why).
Check off the following: