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

add typedoc support #9

Open
amilajack opened this issue Sep 5, 2020 · 7 comments
Open

add typedoc support #9

amilajack opened this issue Sep 5, 2020 · 7 comments

Comments

@amilajack
Copy link
Owner

No description provided.

@hamirmahal
Copy link
Collaborator

I'd like to try this. How should I get started?

@amilajack
Copy link
Owner Author

Sure! Here's some examples:

https://github.com/amilajack/joker
https://typedoc.org/

We'll need to figure out how to host both typedoc and storybook. Maybe we could host typedoc in a different subdirectory. I also recommend working on storybook integration before this so that we can figure out how we can host tsdoc along with storybook

@hamirmahal
Copy link
Collaborator

Okay, sounds good. Thanks for the resources!

@hamirmahal
Copy link
Collaborator

I also recommend working on storybook integration before this so that we can figure out how we can host tsdoc along with storybook

Now that we've taken care of storybook integration with #6, should we move forward with adding typedoc support?

@amilajack
Copy link
Owner Author

Sounds like a good idea!

@hamirmahal hamirmahal mentioned this issue Sep 14, 2020
Merged
amilajack added a commit that referenced this issue Sep 28, 2020
@hamirmahal @amilajack
start progress on #9 by adding yarn and npm TypeDoc dependencies (#14)
ec602f4 
* start progress on #9 by adding yarn and npm TypeDoc dependencies

* add docs and deploy scripts for TypeDoc, progressing #9 forward
	deleted:    docs/classes/_index_.wavesurfercomponent.html

* start progress on #9 by adding yarn and npm TypeDoc dependencies

* add docs and deploy scripts for TypeDoc, progressing #9 forward
	deleted:    docs/classes/_index_.wavesurfercomponent.html

* prevent double-publishing by changing deploy script for #9

* Update package.json

Removing ` "deploy": "yarn docs",` as @amilajack suggested

Co-authored-by: Amila Welihinda <amilajack@gmail.com>

Co-authored-by: Amila Welihinda <amilajack@gmail.com>
@hamirmahal
Copy link
Collaborator

#14 addresses at least part of this. What's next?

@amilajack
Copy link
Owner Author

amilajack commented Sep 29, 2020 •
edited
Loading

We should try to host the generated docs. But at the moment I'd say this is a lower priority. There's a good amount of the API that is still changing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@amilajack @hamirmahal