documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Refactor overview articles to give users a reason to use the product

Open JakeSCahill opened this issue 5 years ago • 0 comments

Is your feature request related to a problem? Please describe. Some of our overviews include too much detailed information. For example, Hub goes into too much detail about how it works.

Overviews should be short article that give users the main benefits of using a product or service.

Describe the solution you'd like

All overviews should have a short, emboldened introductory paragraph describing what the product is, what it's useful for, and who might want to use it.

Below the introductory paragraph, all overviews should have a heading for each benefit and a description of that benefit.

For example, for Hub (these are examples, Hub would have more benefits):

## Two easy-to-use APIs

Set up Hub with a gRPC or REST API and use it to easily integrate your Hub instance into any existing systems.

The Hub APIs come with simple methods for creating new users, monitoring addresses for deposits, and requesting withdrawals.

## Manage users accounts

Hub comes with a database schema for storing and managing users' addresses, balances, withdrawals and deposits.

Describe alternatives you've considered

Additional context

Some overviews include conceptual information. This information should go into a core concepts article in the introduction section.

Some products also have a concepts section with individual articles. This information should go into a core concepts article in the introduction section.

JakeSCahill avatar Apr 09 '20 08:04 JakeSCahill