Low discoverability for Installation doc children

alexweininger commented 3 years ago

Issue

The doc pages that are children of the Installation page are really hard to discover. I think several things are to blame:

Causes

The installation doc is the only doc that has children.
The arrow is really small
It's not clear that these child links are actually links to whole other doc pages. (see explanation below)
Some of the children (env variables mainly) may not make sense to be under a parent named "Installation"

For cause 3, what I mean is on a lot of doc websites they will have links to header anchors of the current doc page as a child of the link. See example taken from https://flareact.com/docs/data-fetching:

Image

Open view:

Closed view:

Potential solutions

Make indicator arrow larger
Make children expanded by default (as long as there aren't too many children)
Make new category called "Server configuration" or "Server management" which can include details about environment variables, how to use docker, upgrading Appwrite, running in production etc.

Personally I think implementing 1. and 3. will be best. And avoiding this style of child links completely might be a good idea. Users just want to see a list of all the pages so they can find info fast. They don't want to have to remember that a certain doc page is a child of another, etc..

If we can decide on a solution we like I am happy to try and tackle this change.