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] Visual re-align #9728

Closed
joecritch opened this issue May 20, 2017 · 10 comments
Closed

[Docs] Visual re-align #9728

joecritch opened this issue May 20, 2017 · 10 comments

Comments

@joecritch
Copy link
Contributor

joecritch commented May 20, 2017

Hi folks.

I'm having a shot at a visual re-align for the React docs.

Goals

  • Create a conservative re-align, that isn't controversial; but still opens up opportunity for future expansion and features (heading towards more of a design system)
  • Avoid major architectural changes, which are best handled as separate PR's in the future

Inspiration

  • GraphQL.org
  • Other gridded sites :)

Process

  • Just mockups at the minute, before I receive the go ahead
  • I would then work on the rest of the elements & viewport sizes
  • Then write the CSS (from scratch? thoughts?)

Other notes

  • Moved sidebar to right hand side to improve readability
  • Collapsed non-current docs nav categories
  • Add an 'intro' paragraph (the first para) to each docs page
  • 5px baseline grid
  • 4 column grid
  • Proxima Nova (same as current site)
  • The footer layout would be tightened up (it's just a screenshot of the current one, atm)

Fire away with your comments.

react-docs-3

react-docs-home-2

cc @gaearon

@joecritch
Copy link
Contributor Author

The screenshots look a little fuzzy for some reason. Here's the mockups as PDFs.

docs-home.pdf
docs.pdf

@gaearon
Copy link
Collaborator

gaearon commented May 20, 2017

cc @lacker Would you be interested in this?

@lorenzos
Copy link

lorenzos commented May 23, 2017

+1 as long as the right sidebar will follow page scrolling 😄
This technique can be useful if the sidebar can be taller than the viewport (like the one currently online).

@joecritch
Copy link
Contributor Author

joecritch commented Jun 5, 2017

@gaearon Just checking in on this. How do you think we should we move forward? (cc @lacker too :-)

@bvaughn
Copy link
Contributor

bvaughn commented Jun 5, 2017

This looks slick! I'd love to lend a hand with this if you need one.

@joecritch
Copy link
Contributor Author

@bvaughn Glad you're into it! I'd love your help dude. Safe for me to get started, then we'll sync? Any thoughts on writing it with new markup?

@bvaughn
Copy link
Contributor

bvaughn commented Jun 7, 2017

@joecritch I don't have the final say on what happens to the docs site but I've been interested in improving it for a while now too. I'll chat about it with Tom in the next day or so and get some more context.

@joecritch
Copy link
Contributor Author

@bvaughn Cheers Brian 👍

@joecritch
Copy link
Contributor Author

@bvaughn I think we can consider this closed ;)

@gaearon
Copy link
Collaborator

gaearon commented Sep 27, 2017

😻

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

No branches or pull requests

6 participants