search

mui / toolpad

Toolpad: Full stack components and low-code builder for dashboards and internal apps.
https://mui.com/toolpad/
MIT License
1.27k stars 282 forks source link

Suggestions on improving schema reference page #2051

Closed prakhargupta1 closed 1 year ago

prakhargupta1 commented 1 year ago

Duplicates

Latest version

Summary 💡

  1. Currently, we show the page with schema content expanded. Collapsing it by default would increase the readability of the doc. Something like:

https://github.com/mui/mui-toolpad/assets/92228082/53c576de-afeb-41ed-9319-5601e5e401a1

  1. Currently, there are 2 permalinks. One is for the heading and the other one for the object definition. Should we just make the heading as the only permalink and remove the second one? Video showing both:

https://github.com/mui/mui-toolpad/assets/92228082/31f0743f-1d2b-4952-bc7d-20030aa62ba9

Examples 🌈

No response

Motivation 🔦

No response

Janpot commented 1 year ago
  1. It starts expanded because it looks more like how the actual files would look in a code editor and it increases the UX when using the browser find in page function.
  2. Deep links are available to improve the shareability of documentation. e.g. to allow us to link to a specific nested property inside of a file.

I propose we leave it this way

prakhargupta1 commented 1 year ago
  1. Somehow, I miss going through the content hierarchy on the right side and then I look for a structure in the contents itself. So, the given the structure is there, let's keep it like this.
  2. Ok