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(docs): added trailing slash to recipes.md #24070

Merged
merged 1 commit into from
May 14, 2020

Conversation

iamdarshshah
Copy link
Contributor

Description

Changes: added trailing slash to helps the user identify the hierarchy of page.

Fix: Breadcrumb issue resolved in /docs/docs/recipes.md

Related Issues

#20767

@iamdarshshah iamdarshshah requested a review from a team as a code owner May 13, 2020 19:50
@gatsbot gatsbot bot added the status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer label May 13, 2020
@iamdarshshah iamdarshshah added type: documentation An issue or pull request for improving or updating Gatsby's documentation and removed status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer labels May 13, 2020
@iamdarshshah iamdarshshah changed the title fix: breadcrumb issue resolved for recipes.md fix(docs): breadcrumb issue resolved for recipes.md May 14, 2020
@iamdarshshah iamdarshshah changed the title fix(docs): breadcrumb issue resolved for recipes.md fix(docs): added trailing slash to recipes.md May 14, 2020
@iamdarshshah iamdarshshah added the status: needs docs review Pull request related to documentation waiting for review label May 14, 2020
Copy link

@AishaBlake AishaBlake left a comment

Choose a reason for hiding this comment

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

I'm going to approve this but a note on links to specific sections: breadcrumbs aren't working without the slash in this case either but they will appear correctly with a slash before the number sign. For example, linking with /docs/recipes/querying-data/#querying-data-with-a-page-query will result in the breadcrumbs displaying correctly.

I'd rather we focus on fixing the root issue than update every instance of this, especially since visitors are likely to go directly to the linked section and never interact with the breadcrumbs.

@AishaBlake AishaBlake merged commit e372224 into gatsbyjs:master May 14, 2020
@iamdarshshah iamdarshshah deleted the fix/docs-recipes branch May 14, 2020 17:43
@iamdarshshah
Copy link
Contributor Author

I'm going to approve this but a note on links to specific sections: breadcrumbs aren't working without the slash in this case either but they will appear correctly with a slash before the number sign. For example, linking with /docs/recipes/querying-data/#querying-data-with-a-page-query will result in the breadcrumbs displaying correctly.

I'd rather we focus on fixing the root issue than update every instance of this, especially since visitors are likely to go directly to the linked section and never interact with the breadcrumbs.

Sure, I need to research more about the trailing slash issue. Just a suggestion, we can have a regular expression that helps us achieve the solution for treating /docs/example and /docs/example/ in a same way. Or we can append / while referencing a file.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: needs docs review Pull request related to documentation waiting for review 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.

2 participants