[WIP] chore: Introduce API Extractor and start generating documentation #5967
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
jackfranklin
commented
Jun 3, 2020
| @@ -22,7 +22,7 @@ import Protocol from './protocol'; | |||
| import { Connection } from './Connection'; | |||
| import { Page } from './Page'; | |||
| import { ChildProcess } from 'child_process'; | |||
| import type { Viewport } from './PuppeteerViewport'; | |||
| import { Viewport } from './PuppeteerViewport'; | |||
There was a problem hiding this comment.
API Extractor doesn't work fully with import type yet so we should use regular imports. This isn't really an issue for us anyway.
jackfranklin
commented
Jun 3, 2020
jackfranklin
commented
Jun 3, 2020
| customQueryHandlers, | ||
| getQueryHandlerAndSelector, | ||
| clearQueryHandlers, | ||
| }; |
There was a problem hiding this comment.
didn't need these as well as the ESM exports
jackfranklin
commented
Jun 3, 2020
| "module": "CommonJS" | ||
| "module": "CommonJS", | ||
| "declaration": true, | ||
| "declarationMap": true |
There was a problem hiding this comment.
API Extractor works off the .d.ts files so we need to generate them now.
mathiasbynens
approved these changes
Jun 3, 2020
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 PR introduces API Extractor to the codebase and generates new Markdown documentation into the
new-docfolder. This documentation is incomplete and not meant to be used!This PR doesn't include the documentation in the
new-docfolder in order to make this PR reviewable. If this lands, I will follow it up with another PR that generates the docs.Once this PR lands we can start slowly documenting our code (by converting the
api.mddocs into TSDoc comments) and once we think the new docs are ready we can make them the primary documentation and remove the old documentation.@mathiasbynens we could exclude
new-docsfrom Git for now, but I think it's useful to see them rendered in pull requests when we begin work on improving them so I've left them in for now. LMK what you think.