readthedocs / website

The Read the Docs community website
16 stars 6 forks source link

Rework product/about page #147

Closed agjohnson closed 2 years ago

agjohnson commented 2 years ago

This is the old "product" page, which sounded better as "about" instead in the nav. So it's the about page now.

I addressed https://github.com/readthedocs/site-community/issues/123 mostly, focusing mostly on content here. We were missing a lot of features, but still using a lot of words to describe the features we were covering. I focused on clearing up language and focusing on the essentials, and included a few product screenshots, where we haven't had any yet.

I wasn't originally aiming for this to be a full list of features, but ended up putting more features in at the bottom of the page too. Overall copy is much shorter, but more features are described in a single page now.


:books: Documentation preview :books:: https://read-the-docs-site-community--147.com.readthedocs.build/en/147/

agjohnson commented 2 years ago

Also:

We should have the ability to link to the section headers. Having an id attribute is probably a good start.

Sections have ids currently:

https://read-the-docs-site-community--147.com.readthedocs.build/en/147/about/#authoring

The page feels pretty dense.

The page has a lot of content. There might be some sections to add some vertical padding, but I wouldn't add too much more. In general, it's pretty well spaced, and too much spacing is going to start separating content too much.

There is a ton of content on this page.

Aye. And we have a lot to distill down on this page. I would certainly not expand this page. But consider a few of these pages for comparison:

Some of the secondary features could be more of a vertical bullet list, but this page doesn't seem any more overwhelming than similar pages on other sites.

ericholscher commented 2 years ago

Sections have ids currently:

Ah great. I got lost in the nested HTML since the id wasn't attached to the heading.

The page has a lot of content. There might be some sections to add some vertical padding, but I wouldn't add too much more. In general, it's pretty well spaced, and too much spacing is going to start separating content too much.

Yea, it might just be the genre of page :)

Aye. And we have a lot to distill down on this page. I would certainly not expand this page. But consider a few of these pages for comparison:

Yea, those pages are also a bit overwhelming. I guess that's the style :)

agjohnson commented 2 years ago

But also, we should totally have some less dense versions of that page, maybe with a slightly narrower focus :smile:

agjohnson commented 2 years ago

Thanks for the eyes! I've moved a couple notes into #157 to come back to next time we want to work on this page. We can come back and add tracking to this page as well, once #155 and #156 are merged.