Skip to content

Update intro/getting started docs#786

Merged
BinaryMuse merged 18 commits intorelease-19.0.0from
mkt/some-docs-updates
Apr 30, 2020
Merged

Update intro/getting started docs#786
BinaryMuse merged 18 commits intorelease-19.0.0from
mkt/some-docs-updates

Conversation

@BinaryMuse
Copy link
Copy Markdown
Contributor

@BinaryMuse BinaryMuse commented Apr 28, 2020

This PR fixes a couple issues with the docs:

  • The Getting Started page is hard to find as the link is the heading and the heading has no visible indication of being clickable
  • The index page (linked to from the Components heading) duplicates a lot of this info but the two pages have drifted out of date over time.

In this PR, I've combined the two pages and made it the index page, and changed the left nav so that a "Getting Started" page appears in the nav; this redirects to the index page and I've set up a now redirect to handle the change.

This also includes the changes from #785

Demo: https://primer-components-git-mkt-some-docs-updates.primer.now.sh/components/

@vercel
Copy link
Copy Markdown

vercel bot commented Apr 28, 2020

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/primer/primer-components/32ya6sti4
✅ Preview: https://primer-components-git-mkt-some-docs-updates.primer.now.sh

@vercel vercel bot temporarily deployed to Preview April 28, 2020 18:48 Inactive
@vercel vercel bot temporarily deployed to Preview April 28, 2020 18:52 Inactive
@vercel vercel bot temporarily deployed to Preview April 28, 2020 18:56 Inactive
@vercel vercel bot temporarily deployed to Preview April 28, 2020 19:01 Inactive
@BinaryMuse BinaryMuse force-pushed the mkt/some-docs-updates branch from e357bd3 to ab21ba4 Compare April 28, 2020 19:02
@vercel vercel bot temporarily deployed to Preview April 28, 2020 19:02 Inactive
@vercel vercel bot temporarily deployed to Preview April 28, 2020 19:10 Inactive
@vercel vercel bot temporarily deployed to Preview April 28, 2020 19:28 Inactive
@vercel vercel bot requested a deployment to Preview April 28, 2020 19:46 Abandoned
@vercel vercel bot temporarily deployed to Preview April 28, 2020 19:46 Inactive
@vercel vercel bot requested a deployment to Preview April 28, 2020 20:43 Abandoned
@vercel vercel bot temporarily deployed to Preview April 28, 2020 20:52 Inactive
@vercel vercel bot had a problem deploying to Preview April 28, 2020 22:05 Failure
@vercel vercel bot temporarily deployed to Preview April 28, 2020 22:07 Inactive
@vercel vercel bot temporarily deployed to Preview April 28, 2020 22:48 Inactive
@BinaryMuse BinaryMuse force-pushed the mkt/some-docs-updates branch from abc7fec to f4a3a56 Compare April 29, 2020 16:29
@vercel vercel bot requested a deployment to Preview April 29, 2020 16:29 Abandoned
@vercel vercel bot temporarily deployed to Preview April 29, 2020 16:30 Inactive
@BinaryMuse BinaryMuse marked this pull request as ready for review April 29, 2020 16:30
@BinaryMuse BinaryMuse changed the base branch from master to release-19.0.0 April 29, 2020 16:50
@BinaryMuse BinaryMuse requested a review from emplums April 29, 2020 16:51
@vercel vercel bot temporarily deployed to Preview April 29, 2020 16:53 Inactive
@vercel vercel bot temporarily deployed to Preview April 29, 2020 20:40 Inactive
@vercel vercel bot temporarily deployed to Preview April 29, 2020 20:56 Inactive
@emplums
Copy link
Copy Markdown

emplums commented Apr 29, 2020

Hey! It looks like by merging the index page, About link, and Getting Started page, we lose the hero image and some of the content that was originally in the index.

I think we should just merge About and Getting Started and keep the index page as is with the hero and a little intro, but maybe remove some of the content that's also in Getting Started and just link to the getting started docs on that page? So the index page would essentially be: hero image, What are Primer Components?, Principles and maybe Local Development?

@BinaryMuse
Copy link
Copy Markdown
Contributor Author

Hey! It looks like by merging the index page, About link, and Getting Started page, we lose the hero image and some of the content that was originally in the index.

Ah I totally missed the hero image, that was my fault. But let it be known that I really dislike our hero image; it takes up almost the entire screen for me. (But that's a different discussion :)

image

I think we should just merge About and Getting Started and keep the index page as is

What are you referring to when you mention About? I only merged two pages (getting started and index).

@BinaryMuse
Copy link
Copy Markdown
Contributor Author

BinaryMuse commented Apr 29, 2020

Oh wait, it's the new heading I added 🙈

So you think the Components subheading should still link to the index page, and have some of the original content (and hero image) and the About Link and Getting Started page should lead to the same page (with installation instructions and such)?

@vercel vercel bot temporarily deployed to Preview April 29, 2020 22:09 Inactive
@vercel vercel bot temporarily deployed to Preview April 29, 2020 22:15 Inactive
@BinaryMuse
Copy link
Copy Markdown
Contributor Author

I added the Hero and the stuff I missed copying over; still think it needs to be two pages? I'm not exactly sure where to link to them from given the subheadings are suboptimal.

@emplums
Copy link
Copy Markdown

emplums commented Apr 29, 2020

This is what I had in mind:

Index:

  • Hero image
  • Intro
  • Principles
  • Local development (heads up the markdown heading is currently broken just for this heading for some reason 🤔, it's just showing the hashes instead of turning it into a heading )

About:

  • redirects to Getting Started
  • Doesn't have a hero image

Getting Started:

  • no hero image
  • has all the getting started docs
  • doesn't include intro/principles/local development

@BinaryMuse
Copy link
Copy Markdown
Contributor Author

Gotcha. Do you think the index page should still be linked to from the Components subheader?

@vercel vercel bot temporarily deployed to Preview April 29, 2020 22:25 Inactive
@BinaryMuse BinaryMuse mentioned this pull request Apr 29, 2020
24 tasks
@BinaryMuse BinaryMuse merged commit 86eb3ee into release-19.0.0 Apr 30, 2020
@BinaryMuse BinaryMuse deleted the mkt/some-docs-updates branch April 30, 2020 20:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants