Skip to content

Commit d9a5332

Browse files
msimbergbcumming
andauthored
Update docs/contributing/index.md
Co-authored-by: Ben Cumming <[email protected]>
1 parent b874241 commit d9a5332

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/contributing/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -496,7 +496,7 @@ If possible, prefer linking to a primary section describing a topic instead of f
496496
However, if you believe it's beneficial to actually repeat the content, consider using [snippets](https://facelessuser.github.io/pymdown-extensions/extensions/snippets/) to avoid repeated information getting out of sync on different pages.
497497
Snippets allow including the contents of a text file in multiple places of the documentation.
498498

499-
For example, the recommended NCCL environment variables are defined in a text file (`docs/software/commuinication/nccl_env_vars`) and included on multiple pages because it's essential that users of NCCL notice and use the environment variables.
499+
For example, the recommended NCCL environment variables are defined in a text file [`docs/software/commuinication/nccl_env_vars`](https://github.com/eth-cscs/cscs-docs/blob/main/docs/software/communication/nccl_env_vars) and included on multiple pages because it's essential that users of NCCL notice and use the environment variables.
500500

501501
Snippets are included with `--8<-- path/to/snippet`.
502502
For example, to include the recommended NCCL environment variables, do the following:

0 commit comments

Comments
 (0)