Skip to content
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

add API review file and build step #381

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Conversation

chrisradek
Copy link
Contributor

This is just a proof of concept. I wanted an easy way to look at the public API of our library according to what types we expose. I'm using api-extractor pointing at the entry-point of our type definitions to generate the API markdown file.

Using this would help allow us to easily detect when the API surface changes, areas for improving our documentation, and detects if we've forgotten to export anything that's referenced by our public API.

Also worth going through to make sure we aren't exporting something that's not actually usable/intended to be used.

@silesky silesky force-pushed the master branch 2 times, most recently from da031b5 to 275d5a3 Compare November 27, 2022 23:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant