Add autogenerated TypeDoc docs #2837
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
acywatson
requested review from
trueadm,
zurfyx,
fantactuka,
tylerjbainbridge and
thegreatercurve
as code owners
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
facebook-github-bot
added
the
CLA Signed
zurfyx
approved these changes
Aug 16, 2022
thegreatercurve
pushed a commit
that referenced
this pull request
Nov 25, 2022
* upgrade docusaurus * add typedoc deps * add typedoc documentation * patched plugin * update module names * add file header * revert eslint changes * shuffle dependencies * lint * remove duplicate headers * move API to separate topnav and sidebar * rename modules
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.
This should help a bit with documentation woes. We'll have to iteratively go through and add comments to functions for this to be really helpful.
One thing to note is that the titles of the "modules" in the sidebar are wrong and can't be overridden without a comment in the file header (has to be at the top of the file). We have a lint rule that was silently overwriting all my changes in the pre-commit 🙄 so I'll need to fix that to support the module name override eventualy.