-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Revive and rework tooling around exported API #2367
Merged
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
davidjgoss
temporarily deployed
to
github-pages
December 28, 2023 14:28 — with
GitHub Actions
Inactive
davidjgoss
temporarily deployed
to
github-pages
December 28, 2023 14:44 — with
GitHub Actions
Inactive
davidjgoss
temporarily deployed
to
github-pages
December 28, 2023 15:15 — with
GitHub Actions
Inactive
davidjgoss
temporarily deployed
to
github-pages
January 2, 2024 00:09 — with
GitHub Actions
Inactive
davidjgoss
temporarily deployed
to
github-pages
January 2, 2024 08:33 — with
GitHub Actions
Inactive
davidjgoss
temporarily deployed
to
github-pages
January 7, 2024 12:49 — with
GitHub Actions
Inactive
davidjgoss
force-pushed
the
revive-api-extractor
branch
from
January 7, 2024 14:39
4fcb889
to
6289319
Compare
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's changed?
api-extractor
to the latest and turn it back on for theapi
entry pointapi-extractor
api-documenter
and the docs it previously generatedtypedoc
and have it deploy to GitHub Pages on every commit tomain
⚡️ What's your motivation?
We added
api-extractor
andapi-documenter
a while ago for the new/api
entry point, but then disabled them due to some weird compatibility issues with hybrid packages and/or protobuf.As we add more to the
/api
entry point soon for plugins, and also look to shrink the exports from the root entry point, we'll get a lot of value fromapi-extractor
as it's very good at finding issues that would cause a poor developer experience for consumers. So I wanted to revive this.api-documenter
on the other hand produces output which is not quite so usable/accessible as an HTML site, and it also doesn't handle multiple entry points.typedoc
is better suited on both fronts for us. So I wanted to switch to this.🏷️ What kind of change is this?
📋 Checklist:
This text was originally generated from a template, then edited by hand. You can modify the template here.