History

Mathias Bynens eddb23b521 chore: update URLs (#5185 )		2019-11-26 13:12:25 +01:00
..
check_public_api	feat(puppeteer): introduce `puppeteer.errors` and `puppeteer.devices` (#4312 )	2019-04-19 15:33:06 -07:00
generate_types	feat(puppeteer): introduce `puppeteer.errors` and `puppeteer.devices` (#4312 )	2019-04-19 15:33:06 -07:00
preprocessor	chore: update URLs (#5185 )	2019-11-26 13:12:25 +01:00
.gitignore	[doclint] move doclint testing to golden	2017-07-13 11:17:02 -07:00
cli.js	docs(contributing): add instructions to build Chromium revisions (#4246 )	2019-04-04 15:34:41 -07:00
Message.js	[doclint] Prepare doclint for more checks	2017-07-31 00:10:59 -07:00
README.md	[doclint] Move doclint under utils/	2017-07-13 00:28:52 -07:00
Source.js	chore: drop Node.js v6 support (#5045 )	2019-10-16 17:00:20 +02:00

DocLint

Doclint is a small program that lints Puppeteer's documentation against Puppeteer's source code.

Doclint works in a few steps:

Read sources in lib/ folder, parse AST trees and extract public API
Read sources in docs/ folder, render markdown to HTML, use puppeteer to traverse the HTML and extract described API
Compare one API to another

Doclint is also responsible for general markdown checks, most notably for the table of contents relevancy.

Running

npm run doc

Doclint has its own set of jasmine tests, located at utils/doclint/test folder.

To execute tests, run:

npm run test-doclint