Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Closed
shubhamzanwar opened this issue Oct 4, 2020 · 5 comments · Fixed by #26
Closed

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

shubhamzanwar opened this issue Oct 4, 2020 · 5 comments · Fixed by #26
Assignees
@michaeltintiuc
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers Hacktoberfest

Comments

@shubhamzanwar
Copy link
Member

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.
@shubhamzanwar shubhamzanwar added documentation Improvements or additions to documentation good first issue Good for newcomers Hacktoberfest labels Oct 4, 2020
@shubhamzanwar shubhamzanwar mentioned this issue Oct 4, 2020
Merged
@michaeltintiuc
Copy link
Contributor

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

@shubhamzanwar
Copy link
Member Author

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

@michaeltintiuc
Copy link
Contributor

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

@shubhamzanwar
Copy link
Member Author

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.

@shubhamzanwar shubhamzanwar changed the title Write script to move autogenerated sidebar content to API from the Interfaces tab Write script to move autogenerated sidebar content to API.widgets from the Interfaces tab Oct 4, 2020
michaeltintiuc added a commit to michaeltintiuc/vue-nodegui that referenced this issue Oct 4, 2020
@michaeltintiuc
Fixes nodegui#25 Fix docs script
7d50cea
michaeltintiuc added a commit to michaeltintiuc/vue-nodegui that referenced this issue Oct 4, 2020
@michaeltintiuc
Fixes nodegui#25 Fix docs script
86b2519
@michaeltintiuc michaeltintiuc mentioned this issue Oct 4, 2020
Merged
@michaeltintiuc
Copy link
Contributor

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

shubhamzanwar pushed a commit that referenced this issue Oct 4, 2020
@michaeltintiuc
adding script for docs setup (#26)
0e5fdc4 
* Fixes #25 Fix docs script

* Use Widgets heading, add ;
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@michaeltintiuc michaeltintiuc

Labels
documentation Improvements or additions to documentation good first issue Good for newcomers Hacktoberfest
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fixes #25 Fix docs script michaeltintiuc/vue-nodegui
2 participants
@michaeltintiuc @shubhamzanwar