docs: Introduce Typedoc #443
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
fb55
commented
Mar 7, 2022
| - run: npm ci | ||
| - name: Build docs | ||
| run: npm run build:docs | ||
| - name: Deploy |
There was a problem hiding this comment.
This pushes built docs to the gh-pages branch. The repo settings will have to be updated to use that branch as the source for GitHub Pages.
wooorm
approved these changes
Mar 7, 2022
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.
The bare minimum to generate docs with Typedoc, and update them on Github Actions. This is needed to have docs again, for eg. #422.
There are quite a few symbols that cannot be resolved right now. Part of the issue is TypeStrong/typedoc#1835, which prevents symbols from being resolved across packages. We also have to expose additional symbols; eg. #301 will be a part of fixing that. All of that will be tackled after this PR.