Upgrade to a new site theme

p-shahi commented 1 year ago

Motivation

The current libp2p docs site uses Hugo Learn, a theme that is outdated and inhibits better ways of organizing content. Thanks to more modern themes, other docs site in the ecosystem (IPFS, Testground, Filecoin, etc.) are better composed, have better UI/UX, and offer a better reading and browsing experience.

Why Important

Described in greater detail here but a new theme will help better organize site subdirectories (like enabling Guides/Examples/Tutorials to have its own section), be more flexible for new content/content types, offer a better UI/UX for readers (better page navigation, improved interface), and be more presentable in general.

Done Criteria

[x] New theme is agreed on and deployed

Design changes are orthogonal and out of scope for migrating to a new theme. For design updates see: https://github.com/libp2p/docs/issues/206

p-shahi commented 1 year ago

Hugo themes to consider: https://www.notion.so/pl-strflt/Choosing-a-new-theme-121b15fccd784f46bcc1134570e353a8

salmad3 commented 1 year ago

With all things considered, the Doks theme is the most reasonable.

It standardizes the docs infrastructure.
- The docs team is migrating the IPFS and IPLD docs to use Doks.
- Launchpad is also using Doks.
It is actively maintained.
Doks allows us to accomplish the ideas & proposals we have raised.
It is quite sleek, better for SEO, and has in-house features like dark mode.

I am still in favor of creating a book-like resource (perhaps as an extension to the docs, maybe separate if its realistic) which we can revisit once the content is migrated.

salmad3 commented 1 year ago

@p-shahi we can migrate to the new theme before the end of the week. I believe it is reasonable to pursue by involving the docs team more than the stewards based on usage of the Doks theme already, consensus by the docs team, and the migration not necessarily impacting additional next steps raised here. However, input is always encouraged @BigLep, @mxinden, @marten-seemann, @MarcoPolo.

mxinden commented 1 year ago

However, input is always encouraged @mxinden

No opinion on a theme for docs.libp2p.io.

libp2p / docs