Skip to content
This repository has been archived by the owner on Sep 29, 2023. It is now read-only.

Low discoverability for Installation doc children #29

Open
alexweininger opened this issue Jun 4, 2021 · 4 comments
Open

Low discoverability for Installation doc children #29

alexweininger opened this issue Jun 4, 2021 · 4 comments

Comments

@alexweininger
Copy link

alexweininger commented Jun 4, 2021

Issue

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

Causes

  1. The installation doc is the only doc that has children.
  2. The arrow is really small
  3. It's not clear that these child links are actually links to whole other doc pages. (see explanation below)
  4. 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:

Screen Shot 2021-06-04 at 1 55 50 PM

Image

Open view:
Screen Shot 2021-06-04 at 1 46 36 PM

Closed view:
Screen Shot 2021-06-04 at 1 46 47 PM

Potential solutions

  1. Make indicator arrow larger
  2. Make children expanded by default (as long as there aren't too many children)
  3. 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.

@aamita96
Copy link

aamita96 commented Sep 27, 2021

Hello @alexweininger, Can I try to look into this issue?

@atishay1743
Copy link

Hello @alexweininger, please assign me this under hacktober fest'21

@alexweininger
Copy link
Author

Sorry, a maintainer has to assign this issue.

@stnguyen90
Copy link
Contributor

@sara-k-48, any thoughts on this?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants