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] Mark localhost URLs as code snippets #20756

Closed
marcysutton opened this issue Jan 21, 2020 · 3 comments
Closed

[docs] Mark localhost URLs as code snippets #20756

marcysutton opened this issue Jan 21, 2020 · 3 comments
Assignees
Labels
type: documentation An issue or pull request for improving or updating Gatsby's documentation

Comments

@marcysutton
Copy link
Contributor

To be consistent in the Gatsby docs, we want to mark all localhost URL references as code highlighted strings instead of links and document this preference in the Gatsby Style Guide.

This is in response to PR #19067, which changed some of these references into links; the problem is that unless you're running gatsby develop or gatsby build locally, those links will not work. We'd therefore prefer to have these listed as code blocks, so we don't have invalid links throughout the docs.

This should be documented in the Style Guide. We could add a new section under "Use clear hyperlinks" that says "Mark localhost URLs as code strings" or something along those lines. https://www.gatsbyjs.org/contributing/gatsby-style-guide

@marcysutton marcysutton added type: documentation An issue or pull request for improving or updating Gatsby's documentation status: inkteam assigned labels Jan 21, 2020
@bball07
Copy link
Contributor

bball07 commented Jan 27, 2020

PR: [docs] Mark localhost URLs as code snippets #20899

@muescha
Copy link
Contributor

muescha commented Feb 4, 2020

more PR for this issue:

@muescha muescha reopened this Feb 4, 2020
@marcysutton
Copy link
Contributor Author

I think this issue can be closed now, thanks for the watchful eye and PRs @muescha!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
None yet
Development

No branches or pull requests

4 participants