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

Linking between pages doc #8626

Merged
merged 3 commits into from
Oct 1, 2018
Merged

Linking between pages doc #8626

merged 3 commits into from
Oct 1, 2018

Conversation

shannonbux
Copy link
Contributor

Wondering if the Gatsby Link doc (docs/gatsby-link/) is actually all we need? Not sure...

@shannonbux shannonbux added the type: documentation An issue or pull request for improving or updating Gatsby's documentation label Sep 28, 2018
@shannonbux shannonbux self-assigned this Sep 28, 2018
@shannonbux shannonbux requested review from amberleyromo and a team September 28, 2018 19:09
Copy link
Contributor

@amberleyromo amberleyromo left a comment

Choose a reason for hiding this comment

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

I think having this doc is very helpful -- not everyone is going to go through the tutorial. I have the same comment i've had recently though, which is that I'm not sure how helpful it is to include the entire code example from the tutorial -- it strikes me as unnecessarily duplicative.

I'd suggest:

  1. Intro language (which you have)
  2. A basic code block showing how to use the Link component (but not in a "step-by-step" guided kind of way.
  3. a link out to the full step-by-step example in the tutorial

Did you mean to link to the API docs twice? I'm not sure it's needed in the body of the doc, and at the end, but that's up to you! Lmk when you think.

@amberleyromo
Copy link
Contributor

@shannonbux I like the changes -- good to go, or still tweaking?

@amberleyromo
Copy link
Contributor

Nevermind, saw your comment in the commit a99974a

I think this is good, quick example and linking out to the longer tutorial explanation 👍

Copy link
Contributor

@amberleyromo amberleyromo left a comment

Choose a reason for hiding this comment

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

👍

@amberleyromo amberleyromo merged commit ca8cccf into master Oct 1, 2018
@shannonbux
Copy link
Contributor Author

shannonbux commented Oct 1, 2018 via email

@shannonbux shannonbux mentioned this pull request Oct 3, 2018
51 tasks
@shannonbux shannonbux deleted the linking-between-pages-doc branch October 3, 2018 16:37
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

Successfully merging this pull request may close these issues.

2 participants