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

Add instructions for changing deeplinks when editing headings #19186

Merged
merged 3 commits into from
Nov 11, 2019

Conversation

laurieontech
Copy link
Contributor

Description

It's important to note that headers automatically generate a URL that can be referenced elsewhere in the docs. PRs that alter headings need to include changes to any existing deep links.

Related Issues

@laurieontech laurieontech requested a review from a team as a code owner October 31, 2019 15:12
@lannonbr lannonbr added the type: documentation An issue or pull request for improving or updating Gatsby's documentation label Oct 31, 2019
Copy link
Contributor

@marcysutton marcysutton left a comment

Choose a reason for hiding this comment

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

This is a fantastic addition. Thanks so much for writing! I left a few really small suggestions; let me know if you have any questions.

docs/contributing/docs-contributions.md Outdated Show resolved Hide resolved
docs/contributing/docs-contributions.md Outdated Show resolved Hide resolved
@laurieontech laurieontech added the bot: merge on green Gatsbot will merge these PRs automatically when all tests passes label Nov 6, 2019
Copy link
Contributor

@marcysutton marcysutton left a comment

Choose a reason for hiding this comment

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

Love it! Thanks again!

@muescha
Copy link
Contributor

muescha commented Nov 11, 2019

just be interested why we not use https://www.gatsbyjs.org/packages/gatsby-remark-check-links/ at the website?

@sidharthachatterjee sidharthachatterjee merged commit eb165e3 into master Nov 11, 2019
@delete-merged-branch delete-merged-branch bot deleted the docs-header-guidelines branch November 11, 2019 15:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bot: merge on green Gatsbot will merge these PRs automatically when all tests passes type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants