From 113428712cb51c3fa4910e3096438ffbbaad01e7 Mon Sep 17 00:00:00 2001 From: Jon Torre <78599298+JTorreG@users.noreply.github.com> Date: Mon, 14 Apr 2025 14:55:34 +0100 Subject: [PATCH 1/2] docs: Update CONTRIBUTING_DOCS.md Update the contributing to docs file to clarify ref and relref usage --- CONTRIBUTING_DOCS.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING_DOCS.md b/CONTRIBUTING_DOCS.md index 28b99cab1..6a6bb2d8b 100644 --- a/CONTRIBUTING_DOCS.md +++ b/CONTRIBUTING_DOCS.md @@ -81,7 +81,8 @@ Close every section with a horizontal line by using three dashes: `---`. ### How to format internal links -Internal links should use Hugo [ref and relref shortcodes](https://gohugo.io/content-management/cross-references/). +Internal links should use Hugo shortcodes [ref](https://gohugo.io/methods/shortcode/ref/#article) (for absolute paths) and [relref](https://gohugo.io/methods/shortcode/relref/#article) (for relative paths). +Please note that we favor absolute paths, as these are easier to maintain. - Although file extensions are optional for Hugo, we include them as best practice for page anchors. - Relative paths are preferred, but just the filename is permissible. From d6685bfdb2ba93d59bd7c92a81bfc119d96953d9 Mon Sep 17 00:00:00 2001 From: Jon Torre <78599298+JTorreG@users.noreply.github.com> Date: Mon, 14 Apr 2025 15:00:09 +0100 Subject: [PATCH 2/2] Update CONTRIBUTING_DOCS.md Co-authored-by: Mike Jang <3287976+mjang@users.noreply.github.com> --- CONTRIBUTING_DOCS.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING_DOCS.md b/CONTRIBUTING_DOCS.md index 6a6bb2d8b..198b8e3e1 100644 --- a/CONTRIBUTING_DOCS.md +++ b/CONTRIBUTING_DOCS.md @@ -84,8 +84,8 @@ Close every section with a horizontal line by using three dashes: `---`. Internal links should use Hugo shortcodes [ref](https://gohugo.io/methods/shortcode/ref/#article) (for absolute paths) and [relref](https://gohugo.io/methods/shortcode/relref/#article) (for relative paths). Please note that we favor absolute paths, as these are easier to maintain. -- Although file extensions are optional for Hugo, we include them as best practice for page anchors. -- Relative paths are preferred, but just the filename is permissible. +- Although file extensions (such as `.md`) are optional for Hugo, we include them as best practice for page anchors. +- We prefer relative paths. - Paths without a leading forward slash (`/`) are first resolved relative to the current page, then the remainder of the website. Here are two examples: