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

[2.0] docs site redesign! #2243

Merged
merged 72 commits into from
Mar 21, 2018
Merged

[2.0] docs site redesign! #2243

merged 72 commits into from
Mar 21, 2018

Conversation

giladgray
Copy link
Contributor

@giladgray giladgray commented Mar 15, 2018

woooooo new design!

To do:

  • v2 label dropdown near "Blueprint" header
  • .docs-sections within .docs-modifiers should have no .pt-running-text class (text too big in props tables currently)
  • navigating with navigator search should update URL
  • initial scrolling element (reload, press page down)
  • change props dialog to a custom overlay
  • banner isn't in .docs-app therefore can't get .pt-dark styles
  • props navigator dialog/overlay doesn't get .pt-dark styles
  • timezone icon
  • core package nav: move components to first-level nav
  • docs-theme API changes (some 🔥 in there)

@giladgray giladgray requested review from llorca and adidahiya March 15, 2018 01:52
@blueprint-bot
Copy link

prevent body scrolling

Preview: documentation | landing | table

Copy link
Contributor

@adidahiya adidahiya left a comment

Choose a reason for hiding this comment

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

looks pretty sweet overall! couple notes:

can I get ESC to close this omnibar please?

image

also can it inherit dark theme?

lastly, these keyboard shortcuts feel out of place, kind of in your face... I would prefer them labeled in a tooltip:

image

&.docs-nav-expanded {
// bold text instead of background color
background-color: transparent !important; // stylelint-disable-line declaration-no-important
font-weight: 600;
Copy link
Contributor

Choose a reason for hiding this comment

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

unfortunate side effect of this is that it can change the number of lines which an item takes up. so it can push down the layout of the rest of the nav tree. a minor inconvenience 🤷‍♂️

Copy link
Contributor

Choose a reason for hiding this comment

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

yeah I noticed as well, I'll update that but maybe not in this PR (unless I figure something great before this merges)

@llorca
Copy link
Contributor

llorca commented Mar 15, 2018

@adidahiya re: shortcuts, they're actually disabled text, can hardly go less in your face than that. we want to display them for a while to let people get used to it, and we can probably remove them at some point.
re: esc to close the omnibar, it already works on my end. did you catch a bug?

@blueprint-bot
Copy link

blueprint-bot commented Mar 20, 2018

🌟 Components becomes non-interactive header that expands its menu!

Preview: documentation | landing | table

@qcz
Copy link
Contributor

qcz commented Mar 20, 2018

@giladgray: When using the latest preview by blueprint-bot, the left menu can't be scrolled in Firefox and Edge.

Gilad Gray added 3 commits March 20, 2018 14:27
inject some styles to add padding equal to scrollbar width when Overlay open
@giladgray
Copy link
Contributor Author

@qcz i believe i've resolved the scrolling issues. thanks for reporting!

@blueprint-bot
Copy link

restore scroll spy

Preview: documentation | landing | table

@blueprint-bot
Copy link

new Logo component rendering logo SVG inline

Preview: documentation | landing | table

Copy link
Contributor Author

@giladgray giladgray left a comment

Choose a reason for hiding this comment

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

@llorca I reviewed your commit

@@ -0,0 +1,27 @@
/*
* Copyright 2015 Palantir Technologies, Inc. All rights reserved.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

2018

export const Logo: React.SFC<ILogoProps> = ({ color }) => {
return (
<svg width="65" height="76" xmlns="http://www.w3.org/2000/svg">
<g fill={color} fill-rule="nonzero">
Copy link
Contributor Author

Choose a reason for hiding this comment

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

fillRule

@@ -32,20 +32,35 @@ $dark-package-colors: (

.docs-logo {
display: block;
opacity: 0.8;
margin-right: $logo-margin;
background-image: url("./assets/blueprint-logo.svg");
Copy link
Contributor Author

Choose a reason for hiding this comment

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

remove these background properties, and the associated file.

while you're at it, refactor this entire class. i'll bet half the properties aren't necessary anymore.

@blueprint-bot
Copy link

fix sidebar width, remove left padding

Preview: documentation | landing | table

@llorca
Copy link
Contributor

llorca commented Mar 21, 2018

  • can we remove the banner now since next time we ship the docs it'll be the stable release?
  • this is looking and working pretty good 😍 shall we merge or do you expect more code review?

make sure the interface description doesn't shrink in api overlay
@blueprint-bot
Copy link

fix api overlay desc size

Preview: documentation | landing | table

@giladgray
Copy link
Contributor Author

@llorca let's merge now and remove banner later. approval?

@blueprint-bot
Copy link

make copy to clipboard tick consistent everywhere

Preview: documentation | landing | table

@@ -40,6 +40,7 @@ $swatch-copied-message: "#{$pt-icon-tick} Copied to clipboard";
// override more specific selector above
//stylelint-disable declaration-no-important
&.docs-clipboard-copied .docs-clipboard-message::after {
font-family: $pt-font-family;
Copy link
Contributor Author

Choose a reason for hiding this comment

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

but we want monospace. whatever.

@giladgray giladgray merged commit aa7c736 into develop Mar 21, 2018
@giladgray giladgray deleted the feature/site-2.0 branch March 21, 2018 18:43
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.

5 participants