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.

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

Typedoc Generated Markdown #448

Draft
wants to merge 2 commits into
base: add-docs
Choose a base branch
from

Conversation

arsdehnel
Copy link
Contributor

Added in typedoc and the typedoc-plugin-markdown to generate vuepress-friendly files. I split it into two commits so you can see the package.json changes (in f4ee644) and then the generated files (in e2e5b1d).

@jetersen
Copy link
Contributor

not sure I see much value in the generated docs same things my editor or IDE would tell me about the type.

Also due to the base service and resource interfaces it becomes a lot of repeated words, it sure is a nice way to get lots of additions 😆

@jdalrymple
Copy link
Owner

@Casz but unless you dl the library you cant see those docs :(. At keast this way people have docs before they install the libs

@arsdehnel
Copy link
Contributor Author

I’d rather have generated docs that have everything and are easy to keep up-to-date than a) what we have now or b) more complete docs that fall out-of-date or require a lot of work.

I think starting with a baseline where we generate what we can and then we can add more ‘curated’ docs as we mature it.

@jdalrymple
Copy link
Owner

This will be much better once #1104 is finished!

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

Successfully merging this pull request may close these issues.

3 participants