spring-io / antora-ui-spring

Mozilla Public License 2.0
13 stars 26 forks source link

Consider creating a dedicated docs design #208

Open philwebb opened 4 months ago

philwebb commented 4 months ago

Currently docs.spring.io is designed to look like an extension of spring.io and replicates the header and footer menus. Whilst this creates a consistent experience, it does mean that we sacrifice a lot of header space for menus that aren't particularly relevant to developers that are only interested in the docs.

Quite a few site have dedicated documentation sites that differ from their main site. Some examples are:

I think it would be interesting to consider what a dedicate docs site for Spring could look like and what (if any) benefits it would give.

One interesting outcome would be the extra header space we have. For example, we could use it to host the search bar which would make it easier to find when there is a large table of contents navigation tree.

e.g.

Original:

Screenshot 2024-02-21 at 9 39 23 AM

Mock up:

docssite

In the mock up, the chevron next to the Spring logo could provide links to sections of spring.io and possibly also start.spring.io.

Buzzardo commented 1 month ago

I like this because it would "surface" the docs rather than have them hidden within another site. The flip side is that readers will have to find a second site. I think the benefit outweighs the potential drawback.