From 8c2b17926c50ce4077f0804fd3a92daecc78dee4 Mon Sep 17 00:00:00 2001 From: Antoine du Hamel Date: Mon, 19 Oct 2020 12:58:55 +0200 Subject: [PATCH] doc: recommend test-doc instead of lint-md The documentation style guide used to recommend checking changes in the docs by running `make lint-md`. This leaves out some important checks which are contained in the `test-doc` build target. This commit also replaces `lint` by `lint-md` in the list of `test-doc`'s prerequisites. PR-URL: https://github.com/nodejs/node/pull/35708 Reviewed-By: Rich Trott Reviewed-By: Michael Dawson --- Makefile | 2 +- doc/guides/doc-style-guide.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Makefile b/Makefile index 4f397c82f65bc5..9883e35582f95e 100644 --- a/Makefile +++ b/Makefile @@ -580,7 +580,7 @@ test-hash-seed: all $(NODE) test/pummel/test-hash-seed.js .PHONY: test-doc -test-doc: doc-only lint ## Builds, lints, and verifies the docs. +test-doc: doc-only lint-md ## Builds, lints, and verifies the docs. @if [ "$(shell $(node_use_openssl))" != "true" ]; then \ echo "Skipping test-doc (no crypto)"; \ else \ diff --git a/doc/guides/doc-style-guide.md b/doc/guides/doc-style-guide.md index b44206ff9e2791..ee039e9e8363eb 100644 --- a/doc/guides/doc-style-guide.md +++ b/doc/guides/doc-style-guide.md @@ -16,7 +16,7 @@ this guide. * Documents should be word-wrapped at 80 characters. * `.editorconfig` describes the preferred formatting. * A [plugin][] is available for some editors to apply these rules. -* Check changes to documentation with `make lint-md`. +* Check changes to documentation with `make test-doc -j` or `vcbuild test-doc`. * [Use US spelling][]. * [Use serial commas][]. * Avoid first-person pronouns (_I_, _we_).