Skip to content

docs: Update CONTRIBUTING_DOCS.md #402

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 15, 2025
Merged

docs: Update CONTRIBUTING_DOCS.md #402

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1134287
docs: Update CONTRIBUTING_DOCS.md
JTorreG Apr 14, 2025
d6685bf
Update CONTRIBUTING_DOCS.md
JTorreG Apr 14, 2025
a908658
Merge branch 'main' into JTorreG-patch-1
ADubhlaoich Apr 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions CONTRIBUTING_DOCS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,10 +81,11 @@ 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.
- 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:
Expand Down
Loading