Skip to content

Commit cb3d5c4

Browse files
[DOCUMENTATION] improved documentation slightly
3 parents 89d3f8f + a7e400f + 2cd43d2 commit cb3d5c4

File tree

3 files changed

+292
-34
lines changed

3 files changed

+292
-34
lines changed

docs/FAQ.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ work as far as this Multicast module is concerned.
233233
documentation site.
234234

235235
* However, if one still wishes to build the documentation manually, there is a `make` target
236-
specifically for this:
236+
specifically for building from source:
237237

238238
```bash
239239
make build-docs
@@ -245,6 +245,8 @@ work as far as this Multicast module is concerned.
245245
to the specific commit you're working on, set the `DOCS_BUILD_REF` environment variable:
246246

247247
```bash
248+
# git clone ...
249+
# git checkout <specific commit>
248250
# shellcheck disable=SC2155
249251
export DOCS_BUILD_REF=$("${GIT:-git}" rev-parse --verify HEAD)
250252
make build-docs # or your own documentation build command

0 commit comments

Comments
 (0)