Skip to content

Commit

Permalink
fix: Clarify CONTRIBUTING_DOCS
Browse files Browse the repository at this point in the history
  • Loading branch information
mjang committed Dec 9, 2024
1 parent 4915355 commit b9a6728
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions CONTRIBUTING_DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit b9a6728

Please sign in to comment.