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

Adapt theme from new website design #53

Merged
merged 4 commits into from
Aug 4, 2019
Merged

Adapt theme from new website design #53

merged 4 commits into from
Aug 4, 2019

Conversation

dennisreimann
Copy link
Contributor

@dennisreimann dennisreimann commented Aug 2, 2019

Proposal on how the design of the upcoming webiste could be adapted for the docs.

I deployed the changes so that everyone can take a look here:
https://docs.wasabiwallet.io/

@mayankchhabra @MaxHillebrand @thunderbiscuit Looking forward to your feedback!

If merged, this would close #4.

@dennisreimann dennisreimann added ready for review Waiting for review and discussion visual Regarding the UI of the documentation labels Aug 2, 2019
Copy link
Collaborator

@MaxHillebrand MaxHillebrand left a comment

Choose a reason for hiding this comment

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

Oh wow - this looks amazing!!
Love the color in the top bar, and especially that font. Thank you very much @dennisreimann!!! ❤️

I noticed that the images are broken, but I'm not sure if this is because of the mocup repo, and if it will be fixed upon merge...

And a general request: can we please do a dark mode? #54 My eyes are bleeding from seeing this much white on a screen... I think this is fitting because the Wasabi GUI is dark as well - and because this documentation is mostly text, which is 💯 times better to read in dark mode.

Copy link
Collaborator

@MaxHillebrand MaxHillebrand left a comment

Choose a reason for hiding this comment

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

Can you please increase the font size a little?

@mayankchhabra
Copy link

mayankchhabra commented Aug 3, 2019

Rock 'n roll! Great work @dennisreimann 👏👏

I like the approach of overwriting the styles with the main website's colors and typography as from whatever I researched, creating a custom Bootstrap layout for vuepress would have been a lot of pain, plus no future updates from vuepress in terms of layout and features. However, the main website uses a lot of bootstrap classes such as text-uppercase/lowercase, colors, and spacings, so you can try pulling those classes to achieve similar results.

Other than that, everything looks great. Agree with Max that a dark mode would be much easier on the eyes as the docs are pretty text-heavy, so you can try inverting the colors.

Some small suggestions that you can consider to achieve a more cohesive theme:

Screen Shot 2019-08-03 at 5 14 07 pm

Changing the "Wasabi Documentation" font to Playfair Display, and the blue button to the green with uppercase text, and I think we should also change the text to "Read the docs" instead of "reclaim your privacy".


Screen Shot 2019-08-03 at 5 13 28 pm

The website uses lowercase for all the headings, so we can do the same in the docs as well for all the headings in Playfair font


Screen Shot 2019-08-03 at 5 13 05 pm

Uppercase Inconsolata would look great for sub-headings like this one "Manual public key import", with a tad bit of increased letter spacings.

Closes #4.

Signed-off-by: Dennis Reimann <mail@dennisreimann.de>
Signed-off-by: Dennis Reimann <mail@dennisreimann.de>
This uses the CSS media query prefers-color-scheme to adapt to the users system settings. Closes #54.

See these for details:
https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme
https://twitter.com/DennisReimann/status/1157714320324747265

Signed-off-by: Dennis Reimann <mail@dennisreimann.de>
@dennisreimann
Copy link
Contributor Author

Can you please increase the font size a little?

Done with 712cf97.

@mayankchhabra I also incorporated your suggestions and feedback in the finetuning commit.

You can take a look at the current website, I deployed it with the recent changes including dark mode… https://docs.wasabiwallet.io/

Speaking of dark mode: According to the quantitative research done by @MaxHillebrand our users prefer the dark side, so we made it the default. But as we don't want to put off the users that would rather use light mode, we cater to theirneeds with the CSS prefers-color-scheme media query.
Browsers that support this show the theme depending on the users system preferences, see my tweet for details.

Increase font size in nav and fix code blocks

Signed-off-by: Dennis Reimann <mail@dennisreimann.de>
@MaxHillebrand
Copy link
Collaborator

As written in #57, we should increase the font size of the top nav bar.

Maybe even with the general font as well?

Copy link
Collaborator

@MaxHillebrand MaxHillebrand left a comment

Choose a reason for hiding this comment

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

As discussed in PM with Dennis - this is ready to merge, with the minor tweaks still needed done in a separate PR in the future.

This is an AWESOME PR - seriously, I LOVE this design so much!!
Thanks Dennis!!!

@MaxHillebrand MaxHillebrand merged commit 9ec1836 into master Aug 4, 2019
@dennisreimann
Copy link
Contributor Author

dennisreimann commented Aug 4, 2019

Thanks for the kind words, Max! I hope this will be one of many little contributions that will make the whole more than the sum of all parts. The efforts of the community help grow this project to become a valuable resource about Wasabi and privacy in Bitcoin in general. A much needed and invaluable resource for the generations of HODLers to come 😀

@dennisreimann dennisreimann deleted the theme branch August 4, 2019 09:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready for review Waiting for review and discussion visual Regarding the UI of the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Make Wasabi fitting theme
3 participants