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: #35708 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Michael Dawson <midawson@redhat.com>
nodejs · Nov 3, 2020 · 8c2b179 · 8c2b179
1 parent a5fa849
commit 8c2b179
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git 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
@@ -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_).