Draft
Conversation
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 😆 |
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 |
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. |
Owner
|
This will be much better once #1104 is finished! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added in
typedocand thetypedoc-plugin-markdownto generate vuepress-friendly files. I split it into two commits so you can see thepackage.jsonchanges (in f4ee644) and then the generated files (in e2e5b1d).