Write script to move autogenerated sidebar content to API.widgets from the Interfaces tab

Question

Write script to move autogenerated sidebar content to API.widgets from the Interfaces tab

shubhamzanwar opened this issue 4 years ago · 5 comments

When you run npm run docs, TypeDoc automatically created a new "Interfaces" key in the sidebar.
As a solution to this issue, we would need to write a script to move contents from here to the "Api" section.

Answer 1 · 2020-10-04T12:28:39.000Z

@shubhamzanwar I'd be happy to lend a hand with this issue

Answer 2 · 2020-10-04T12:31:05.000Z

Go for it 🤘🏽
You can check out nodegui to see how it's being fixed there.
Should give a basic idea to get started :D

Assigning this to you. If you need some help, drop a message here :D

Answer 3 · 2020-10-04T12:53:29.000Z

@shubhamzanwar it seems to me that Widgets and Interfaces arrays are identical, do you want to keep one or the other?

Answer 4 · 2020-10-04T12:55:53.000Z

Everytime TypeDoc runs, it generates the Interfaces array. We want to replace the api.widgets array with the Interfaces array and then remove the Interfaces array.

Answer 5 · 2020-10-04T13:54:30.000Z

This is what the generated website API tab looks like with the above PR