Gensim: RFC: New website design

Created on 29 Aug 2020 · 6Comments · Source: RaRe-Technologies/gensim

I've hired a designer to redesign the Gensim website, give it a more modern & unified look for our 4.0 release.

I asked them to keep the same content + structure = static "plain HTML" pages for the "outside" website, plus auto-generated docs for the "inside" API ref. Just looking better than the current https://radimrehurek.com/gensim/.

The designer came up with the following options. They are generic templates, to be customized and filled with content, so it's only about the general look&feel at this point.

"Outside" pages

"Inner" API reference pages

@gojomo @mpenkov any preference? Your input and comments are welcome. Otherwise I'll go ahead and pick something, not critical. Cheers.

documentation

Source

piskvorky

Most helpful comment

One key functional comment: On my retina MBP16", in Brave with page zoom at default, and browser width about 3/4 of my screen, the header navigations links ('Home Documentation Support API About`) were folded into the hamburger-menu. That made me think they were an inconvenient extra click away, until I noticed them appear when trying a smaller font. I'd suggest ensuring that the header links appear on any viewport that's 1024px or wider - so that it's only on truly mobile/constrained browsers that the drop-down menu is required.

Overall it looks very nice & the having the docs in a familiar read-the-docs layout, with permanent navigation links in the left margin, will be very beneficial.

If anything, the overall style/spacing of the main landing page may be a bit too slick, giving strong impression of a subscription SaaS product sales pitch for end-users, rather than a library for developers. This extends to some of the wording: "Try now for free" sounds like some sort of time-limited signup, rather than forever-free open-source. I tend to expect open-source stuff to be a bit more spartan, info-dense, and even rough-around-the-edges. For more info-density & 'developer feel' I'd suggest:

shrinking giant main title "gensim: topic modelling for humans" from full screen to just a header
eliminating the 'dashboard' graphic unless/until it's a highly-relevant image
at this point, 'explore all features' button to scroll-jump down probably isn't necessary, as the list-of-features will already begin on-screen above-the-fold
eliminate redundant [orange] 'features' [big blue] 'Features of gensim phyton library' dual-headers in favor of one smaller 'features' - also note 'phyton' typo
standardize whether 'gensim' is capitalized or not when mid-sentence - varies across page
generally shrink fonts a bit to get more on screen at once
include better-labelled links to both PyPI page & Github project. For example, a 'download now' link isn't exactly the right 'call-to-action' for either casual library users or code-hackers, who'd be more likely to want a more prominent link to 'install' (or 'installation instructions' ) or to 'github project page'
replacing the placeholder contact-icons for things like FB/Instagram/GooglePlus with working icons to Github/Gitter/GoogleGroups

For the docs:

It seems we have no "how to install" section in the docs - thus the 'download now' link just goes to the PyPI page. But such a page recommending pip install gensim for most cases, recommending the use of a virtual environment, alluding to the popular conda option, & mentionig some common pitfalls/workarounds could head off some support issues, and provide a key docs entry point from either the landing-page or other places where we or others recommend gensim
is there a plan to keep more than one version of the autogenerated docs up? many projects do, with cross-version navigation links & top-of-page warnings when looking at older docs – and some big version transitions (including upcoming 3.8.3 to 4.0.0) may benefit from keeping both sets of docs up

Finally, it'd be good if the landing page had some dedicated, near-the-top line for "latest news" and/or "latest release" - typically just a dated link of the form "Latest: gensim-X-Y-Z released, 2020-MM-DD" to the mailing-list-post or github-page detailing the most-recent release.

gojomo on 16 Sep 2020

👍2

All 6 comments

…my preference is large fonts, static content (nothing jumping/moving) and airy. So these three:

And for API docs, the recognizable https://sphinx-rtd-theme.readthedocs.io/en/stable/ .

piskvorky on 29 Aug 2020

👍1

Had a look, I agree with your picks and the readthedocs scheme.

mpenkov on 30 Aug 2020

@mpenkov @gojomo here's the close-to-finish draft of the new website:
https://stage.friendlystudio.cz/gensim-doc

Any comments, suggestions? Now is the right time :)

Things that will still change for sure:

Update logo + fix the tooltip on logo hover.
Fix the "main image" / code sample on top
Fix a few images + typos.

Things that will change only if we shout:

font types, colours, layouts

Otherwise the site structure, layout and content are complete. The switch should not require any changes to our deployment process: it's still static HTML generated by Sphinx.

piskvorky on 15 Sep 2020

Overall it looks very nice & the having the docs in a familiar read-the-docs layout, with permanent navigation links in the left margin, will be very beneficial.

shrinking giant main title "gensim: topic modelling for humans" from full screen to just a header
eliminating the 'dashboard' graphic unless/until it's a highly-relevant image
at this point, 'explore all features' button to scroll-jump down probably isn't necessary, as the list-of-features will already begin on-screen above-the-fold
eliminate redundant [orange] 'features' [big blue] 'Features of gensim phyton library' dual-headers in favor of one smaller 'features' - also note 'phyton' typo
standardize whether 'gensim' is capitalized or not when mid-sentence - varies across page
generally shrink fonts a bit to get more on screen at once
include better-labelled links to both PyPI page & Github project. For example, a 'download now' link isn't exactly the right 'call-to-action' for either casual library users or code-hackers, who'd be more likely to want a more prominent link to 'install' (or 'installation instructions' ) or to 'github project page'
replacing the placeholder contact-icons for things like FB/Instagram/GooglePlus with working icons to Github/Gitter/GoogleGroups

For the docs:

It seems we have no "how to install" section in the docs - thus the 'download now' link just goes to the PyPI page. But such a page recommending pip install gensim for most cases, recommending the use of a virtual environment, alluding to the popular conda option, & mentionig some common pitfalls/workarounds could head off some support issues, and provide a key docs entry point from either the landing-page or other places where we or others recommend gensim
is there a plan to keep more than one version of the autogenerated docs up? many projects do, with cross-version navigation links & top-of-page warnings when looking at older docs – and some big version transitions (including upcoming 3.8.3 to 4.0.0) may benefit from keeping both sets of docs up

gojomo on 16 Sep 2020

👍2

I'd like to keep several versions (releases) in the navigation too. It's not critical but nice-to-have.

I'm not sure how to do it with Sphinx, but I saw it in other projects, should be possible.

All good points, I'll either pass it on to the web devs (issues with design) or correct myself (wrong copy, typos, content). Thanks!

piskvorky on 16 Sep 2020

No comments from me, other than it looks good!

mpenkov on 16 Sep 2020

Was this page helpful?

0 / 5 - 0 ratings