Skip to content

Fix #7595: Redesign dottydoc theme #7612

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

Merged
merged 8 commits into from
Nov 25, 2019

Conversation

TheElectronWill
Copy link
Contributor

@TheElectronWill TheElectronWill commented Nov 24, 2019

This PR:

  • makes the sidebar more narrow, and applies some other tweaks (e.g. color the current page and don't make the sidebar fullscreen on mobile)
  • (re)sets the colors to a light palette
  • replaces Source Code Pro by Fira Code
  • replaces Source Sans Pro by Lato
  • removes Lobster (the curvy script font used in the navbar)

Ligatures: Fira Code provides font ligatures, which I've disabled to avoid confusing people. I can enable them if you don't believe they will be a problem.

Text font: Nobody seems to dislike the current text font, but maybe you'd prefer another one?
EDIT: Lato is widely appreciated in the Scala community, and for me it increases readability over the current font. It also works very well with Fira Code.

Theme Comparison

Current theme:

Screenshot_2019-11-24 Enumerations

New theme:
Screenshot_2019-11-24 Enumerations(1)

Font Choice

Please click on the image to open it in full size. Do you have a preference?

Current theme: Roboto Slab
Proposal (EDIT: applied in this PR): Lato
Alternative: Roboto or something else

Roboto Slab (current):

Screenshot_2019-11-24 Import Given

Lato (proposal - used by scala-lang.org and many Scala projects):
Screenshot_2019-11-24 Import Given(2)

Roboto (used by the Rust Book):
Screenshot_2019-11-24 Import Given(1)


I think this addresses most of the issues raised in #7595. Please tell me what you think! All comments are welcome.

@TheElectronWill
Copy link
Contributor Author

TheElectronWill commented Nov 24, 2019

PS: this PR does not change the front page.
However it seems clear that it needs to be redesigned too, we'll have to talk about this.

@smarter smarter requested a review from odersky November 24, 2019 18:37
Copy link
Contributor

@odersky odersky left a comment

Choose a reason for hiding this comment

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

I can't judge the changes looking at the source code since I don't know enough about the technologies used. Is there are way to pre-view the outcome? If not, I'd say let's just try it and tweak it later if necessary.

@TheElectronWill
Copy link
Contributor Author

TheElectronWill commented Nov 25, 2019

@odersky There are some screenshots in the "details" of the Theme Comparison and Font Choice sections.

If you want to have the full website you can pull and run sbt genDocs (output will be in docs/_site), but the screenshots should be enough for a non-detailed comparison.

Copy link
Member

@smarter smarter left a comment

Choose a reason for hiding this comment

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

LGTM, thanks a lot for taking the time to do this ! Using the same font that scala-lang uses makes sense to me.

@smarter smarter merged commit 8c48334 into scala:master Nov 25, 2019
@odersky
Copy link
Contributor

odersky commented Nov 25, 2019

I think it's a huge improvement! There's one thing we could still fiddle with: I have the impression the code font is a bit thin. If I compare with, say, the Rust Book, their code fonts seem to have a bit more weight. Can we achieve the same?

@julienrf
Copy link
Contributor

julienrf commented Nov 25, 2019

The result looks great, thanks @TheElectronWill!

The blog articles list still looks ugly in my opinion, though:

Screenshot from 2019-11-25 16-45-49

What do you think of decreasing the font weight?

@TheElectronWill
Copy link
Contributor Author

TheElectronWill commented Nov 25, 2019

I think it's a huge improvement! There's one thing we could still fiddle with: I have the impression the code font is a bit thin. If I compare with, say, the Rust Book, their code fonts seem to have a bit more weight. Can we achieve the same?

I see what you mean. Hopefully I can just increase the font weight property and it will look nice, I'll try that.

The blog articles list still looks ugly in my opinion, though.
What do you think of decreasing the font weight?

I think it's the font size that especially needs some tweaking. The headings are way bigger than the posts' summaries. On mobile the first title takes almost 1/2 of the page!

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