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

Landing page quick links #168

Merged
merged 11 commits into from
Sep 23, 2021
Merged

Landing page quick links #168

merged 11 commits into from
Sep 23, 2021

Conversation

codemonkey800
Copy link
Contributor

@codemonkey800 codemonkey800 commented Sep 21, 2021

Description

This renders the grid of links + descriptions at the bottom of the landing page. This works by adding a new frontmatter key called quickLinks that accepts a list of objects with the format:

theme:
  quickLinks:
    - title: Community
      content: Meet the team, our mission, and our values
      url: /community/index.html
    ...

Demo

https://napari-org-grid-toc.vercel.app/#help

image

Copy link
Contributor

@liaprins-czi liaprins-czi left a comment

Choose a reason for hiding this comment

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

Excited to see this! There are just a couple of things to update and to note:

  • The headers should be Sentence case (to match the ideal way of doing titles of documentation also), so basically only the first letter of the entire heading should be capitalized, not the First Letter of Each Word (right now it is a mix of both approaches)
  • The text descriptions for each are just what I had written as placeholder and based on my own knowledge, but it'd be good to have @sofroniewn et al finalize and probably have @melissawm input too! But in the meantime, the descriptions for Developer resources and Source code look like they are copy--and-paste of Developer guides: all three have the same but the last couple don't match what i had as placeholder / my-best-guess text.
  • It looks like the left side fo the left-most items are slightly indented compared to the rest of the text
  • At narrower screen sizes, the width of the grid items should expand (there just needs to maintain the horizontal (and vertical) spacing), but they should widen accordingly when there are less grid items to fit across

Screen Shot 2021-09-21 at 2 13 53 PM

Other than that I think it looks good to me 👍

@codemonkey800
Copy link
Contributor Author

Thanks for the feedback @liaprins-czi! I'll work on this right away.

The text descriptions for each are just what I had written as placeholder and based on my own knowledge, but it'd be good to have @sofroniewn et al finalize and probably have @melissawm input too! But in the meantime, the descriptions for Developer resources and Source code look like they are copy--and-paste of Developer guides: all three have the same but the last couple don't match what i had as placeholder / my-best-guess text.

The glory of programming is copy-and-paste 😆 I'll fix those items so that they use the correct descriptions. As for the content in general, I think that's fine since there are some content changes we'll need to update so that it works nicely with the theme. This can come before or during the content refactor.

@codemonkey800 codemonkey800 changed the title Landing page grid TOC Landing page ~grid TOC~ quick links Sep 22, 2021
@codemonkey800 codemonkey800 changed the title Landing page ~grid TOC~ quick links Landing page quick links Sep 22, 2021
Copy link
Contributor

@justinelarsen justinelarsen left a comment

Choose a reason for hiding this comment

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

LGTM! 💨 🔗

@codemonkey800
Copy link
Contributor Author

@liaprins-czi the styling has been updated. Could you take another look please 😄

@codemonkey800 codemonkey800 mentioned this pull request Sep 22, 2021
@sofroniewn
Copy link
Contributor

The text descriptions for each are just what I had written as placeholder and based on my own knowledge, but it'd be good to have @sofroniewn et al finalize and probably have @melissawm input too!

@jni can you take a look at this too. Will this PR make the changes go live, or can they get merged and then can we refine to copy later. I don't want to be the bottleneck on getting this merged, but also the copy should get reviewed/ lined up with proposals from @melissawm (right now it looks like the text for Dev Guides and Dev Resources is the same for example).

@codemonkey800
Copy link
Contributor Author

The text descriptions for each are just what I had written as placeholder and based on my own knowledge, but it'd be good to have @sofroniewn et al finalize and probably have @melissawm input too!

@jni can you take a look at this too. Will this PR make the changes go live, or can they get merged and then can we refine to copy later. I don't want to be the bottleneck on getting this merged, but also the copy should get reviewed/ lined up with proposals from @melissawm (right now it looks like the text for Dev Guides and Dev Resources is the same for example).

I didn't include any copy changes in this PR so nothing will change on the current documentation. Also the theme is still disabled so merging this won't change the docs, giving us time to refine the copy before we fully release the theme.

@sofroniewn
Copy link
Contributor

I didn't include any copy changes in this PR so nothing will change on the current documentation. Also the theme is still disabled so merging this won't change the docs, giving us time to refine the copy before we fully release the theme.

Ok nice, yeah i just realized I was reading the wrong text in an old screenshot, not the stuff in the link which look good

This all looks good to me then, merge when ready 🚀

@codemonkey800 codemonkey800 merged commit a340f18 into main Sep 23, 2021
@codemonkey800 codemonkey800 deleted the jeremy/landing-page-grid-toc branch September 23, 2021 20:37
kne42 added a commit to kne42/napari.github.io that referenced this pull request Sep 23, 2021
* main:
  Theme fixes and more (napari#169)
  Landing page quick links (napari#168)
  Fix docs deployment
kne42 added a commit to kne42/napari.github.io that referenced this pull request Sep 24, 2021
* main:
  Theme fixes and more (napari#169)
  Landing page quick links (napari#168)
  Fix docs deployment
  Bump nth-check from 2.0.0 to 2.0.1 (napari#167)
  Page intros from Markdown front matter (napari#162)
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.

4 participants