add type doc #145
Merged
add type doc #145
Conversation
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
mt-dfrey
force-pushed
the
add-type-doc
branch
2 times, most recently
from
b976e1e to
976e7c2
Compare
Merged
mt-rorykelly
approved these changes
Oct 5, 2023
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.
Type doc generates browsable documentation of the typescript definitions.
This makes our docs more maintainable. Currently we use markdown tables to document method parameters, required-ness & types. These drift easily and incur duplication. The generated documentation approach prevents the duplication (i.e. declaring types twice) and the drift (markdown doc contradicting code).
5e80226 just runs the static page generation (
yarn build:docs), so it's not really meant for human review.