Update typedoc and rebuild documentation #76
Merged
Conversation
This file contains 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.
What does this change?
Updates our typedoc plugins, which were broken for unknown reasons, and regenerates our documentation.
There are known issues with typedoc's library mode that mean the generated type information is incomplete, particularly references to interfaces, but this is still an improvement on what was there before.
I've also added/updated some of the comments in the documentation to better describe the public APIs.
How to test
The readme in ./docs should reflect the readme in ./build.
The type information referenced in the readme should exist and be ... moderately useful, although it can definitely be improved!