7db4f0f798
One of our checks makes sure all links from README.md to API.md point to the last-released version of the API. This sometimes doesn't work: when we refer to a section in api.md that is just added, we should be able to reference the "master" version of the api.md This patch: - teaches the doclint check to keep links to tip-of-tree version of api.md in README.md intact. - starts refering to tip-of-tree version of api.md in `puppeter-core` section |
||
|---|---|---|
| .. | ||
| check_public_api | ||
| preprocessor | ||
| .gitignore | ||
| cli.js | ||
| Message.js | ||
| README.md | ||
| Source.js | ||
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
Tests
Doclint has its own set of jasmine tests, located at utils/doclint/test folder.
To execute tests, run:
npm run test-doclint