oceanprotocol / docs

🐬 Ocean Protocol documentation
https://docs.oceanprotocol.com
Apache License 2.0
61 stars 41 forks source link

Low-hanging fruit for approachability #1407

Closed trentmc closed 11 months ago

trentmc commented 11 months ago

Background

When people come to the docs, they encounter 8 boxes: Discover, User Guides, Developers, etc. Newcomers would typically click the first box "Discover".

This takes them to the discover/README page "Why Ocean?" showing:

Screenshot 2023-12-21 at 05 59 57

There are also a couple videos.

The next two pages are discover/explore "Explore", and discover/ocean-101 "Ocean 101". All three of these pages have large amounts of text.

Then discover/basic-concepts "Basic Concepts" has many long paragraphs on blockchain, how Ocean uses blockchain, and OCEAN.

Then discover/wallets "Wallets" and discover/wallets/metamask-setup is generic content on using wallets & metamask.

The opportunity

We can onboard people much better if we revamp the prime real estate of the first three pages, and the developer landing page. Here's how.

The first page is critical prime real estate. We can help onboard people better if they can quickly understand Ocean, and have quicklinks to the rest. So have:

The second page is also key real estate. In it, have:

The next page can have:

The pages on wallets, metamask setup, and manage your OCEAN can be in user guides section.

Many will jump to the developer page. That page is prime real estate for developers. We can onboard devs if they can quickly understand benefits to them, and how they might start using Ocean. This is how data scientists page is now.

Also: people really love OCEAN token but docs don't talk to it directly.

Also: the navigation "link to next page" should be across more of docs. And there should be a "back" link too.

Also: any larger pages should have a table of contents (TOC) at the top. It helps navigability, a lot. In addition to telling the user the precise content.

TODOs