From b9a6728738e379ca30cbdf5c4189234f37f0ef58 Mon Sep 17 00:00:00 2001 From: Mike Jang Date: Mon, 9 Dec 2024 11:44:31 -0800 Subject: [PATCH] fix: Clarify CONTRIBUTING_DOCS --- CONTRIBUTING_DOCS.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING_DOCS.md b/CONTRIBUTING_DOCS.md index 1b34dc24b..faf41edcd 100644 --- a/CONTRIBUTING_DOCS.md +++ b/CONTRIBUTING_DOCS.md @@ -38,11 +38,9 @@ The configuration files are as follows: To build the documentation locally, use the `make` command in the documentation folder with these targets: ```text -make docs - Builds the documentation. -make watch - Runs a Hugo server to automatically preview changes on a local browser. Use this if you want to preview - the documentation locally before submitting a PR. -make drafts - Runs a Hugo server, and displays documentation marked as drafts on a local browser. By default, drafts - are not displayed. +make watch - In most cases, when preparing doc updates, use this command. It runs a Hugo server to automatically preview changes on a local browser. Use this to preview proposed changes before you submit a PR. +make docs - Builds the documentation in the local `public/` directory. +make drafts - Runs a Hugo server. Includes pages with `draft: true` in their metadata. make hugo-get - Updates the go module file with the latest version of the theme. make hugo-tidy - Removes unnecessary dependencies from the go module file. make hugo-update - Runs the hugo-get and hugo-tidy targets in sequence.