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.

Sign up for GitHub

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

Jump to bottom

docs: misc feedback improvements #15236

Merged
merged 10 commits into from
Jul 3, 2019
Merged

docs: misc feedback improvements #15236

merged 10 commits into from
Jul 3, 2019

Conversation

marcysutton
Copy link
Contributor

@marcysutton marcysutton commented Jun 29, 2019 •
edited
Loading

Description

For my regular pass on comments from the feedback widget as well as working on recipes, this PR includes some various docs improvements. What I updated:

Related feedback comments:

I wanted to figure out how to use reach's Router component in combination with Gatsby. I think this tutorial should be referenced in the gatsby Link docs because I wasn't able to find this page by searching the docs site with "Router"

"There must be a mistake in one of the example tests where there is an an import which is not used in the example. "import Index from "../pages/index" but later on a few lines down it turns into which I assume is supposed to be Index. I am normally not picky but this is about testing which should be a very accurate subject with examples."

Related Issues

N/A
@marcysutton marcysutton added type: documentation An issue or pull request for improving or updating Gatsby's documentation topic: feedback labels Jun 29, 2019
@marcysutton marcysutton requested a review from a team June 29, 2019 01:10
gillkyle
gillkyle previously approved these changes Jul 1, 2019
View reviewed changes
Copy link
Contributor

@gillkyle gillkyle left a comment

Choose a reason for hiding this comment

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

Looks good to me, wondering if we'll need to go in and rename requirements -> prerequisites in existing recipes now?
docs/contributing/docs-templates.md Show resolved Hide resolved
marcysutton
marcysutton commented Jul 1, 2019
View reviewed changes
docs/docs/recipes.md

Craving a happy medium between doing the [full tutorial](/tutorial/) and crawling the [full docs](/docs/)? Here's a quick guiding reference for how to build things, Gatsby style.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I had these changes locally, thought I'd shipped them weeks ago but it sure doesn't look like they were in source control! This page will get more significant changes to it soon–and we can get rid of the hard-coded TOC when that component gets merged.
@gillkyle gillkyle mentioned this pull request Jul 3, 2019
Merged
gillkyle
gillkyle approved these changes Jul 3, 2019
View reviewed changes
docs/docs/recipes.md Show resolved Hide resolved
@marcysutton marcysutton merged commit 8810398 into master Jul 3, 2019
@marcysutton marcysutton deleted the docs-improvements-0628 branch July 3, 2019 20:44
@gillkyle gillkyle mentioned this pull request Jul 5, 2019
Merged
johno pushed a commit to johno/gatsby that referenced this pull request Jul 17, 2019
@johno
docs: misc feedback improvements (gatsbyjs#15236)
e05008f 
* fix: add more details to recipes template

* fix: add link to auth tutorial from Gatsby Link

* fix: correction in testing components doc

* fix: add mention of npx in Quick Start

* fix: add notes about accessible headings in docs

* fix: remove note about npx, reshooting video

* fix: update recipes page with new format

* fix: remove bit about KPIs to keep the doc focused

* fix: update Style Guide for new docs formats
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
3 participants
@marcysutton @KyleAMathews @gillkyle