README.md
1# DocLint
2
3**Doclint** is a small program that lints Puppeteer's documentation against Puppeteer's source code.
4
5Doclint works in a few steps:
6
71. Read sources in `lib/` folder, parse AST trees and extract public API. Note that we run DocLint on the outputted JavaScript in `lib/` rather than the source code in `src/`. We will do this until we have migrated `src/` to be exclusively TypeScript and then we can update DocLint to support TypeScript.
82. Read sources in `docs/` folder, render markdown to HTML, use puppeteer to traverse the HTML and extract described API.
93. Compare one API to another.
10
11Doclint is also responsible for general markdown checks, most notably for the table of contents relevancy.
12
13## Running
14
15```bash
16npm run doc
17```
18
19## Tests
20
21Doclint has its own set of jasmine tests, located at `utils/doclint/test` folder.
22
23To execute tests, run:
24
25```bash
26npm run test-doclint
27```
28