From 1803d49ce86556e4182522eddb2343f98678f26c Mon Sep 17 00:00:00 2001 From: ParzivalPavlis Date: Thu, 11 Sep 2025 11:52:11 +0200 Subject: [PATCH 1/2] docs: ensure valid links in API reference and sidebar navigation risk: low --- docs/layouts/partials/api-ref-link-all-partial.html | 2 ++ docs/layouts/partials/api-ref-link-partial.html | 2 +- docs/layouts/partials/navbar-version-selector.html | 5 +++++ docs/layouts/partials/sidebar.html | 12 +++++++++--- 4 files changed, 17 insertions(+), 4 deletions(-) diff --git a/docs/layouts/partials/api-ref-link-all-partial.html b/docs/layouts/partials/api-ref-link-all-partial.html index 0d09b7c36..0e81805f6 100644 --- a/docs/layouts/partials/api-ref-link-all-partial.html +++ b/docs/layouts/partials/api-ref-link-all-partial.html @@ -8,6 +8,7 @@ {{ $links := . }} {{ range $name, $data := $links }} + {{ if and $data.path (ne $data.path "") }} {{ $path := $data.path }} {{ $kind := $data.kind }} {{/* I don't think there is any other way to include literal backtick inside a raw-string */}} @@ -29,6 +30,7 @@ {{ $a_html := (printf "$1%s$3" $path $name) }} {{ $paragraph = replaceRE $pattern $a_html $paragraph | safeHTML}} {{ end }} + {{ end }} {{ end }} {{/* Remove backticks around links */}} diff --git a/docs/layouts/partials/api-ref-link-partial.html b/docs/layouts/partials/api-ref-link-partial.html index 4f784599c..4902895c1 100644 --- a/docs/layouts/partials/api-ref-link-partial.html +++ b/docs/layouts/partials/api-ref-link-partial.html @@ -14,7 +14,7 @@ {{ $name := replace $name "List[" "" }} {{ $data := index $links (trim $name " ") }} - {{ if $data }} + {{ if and $data $data.path (ne $data.path "") }} {{ $path := $data.path }} {{ $a_html := (printf "%s" $path $name) }} {{ replace $orig_name $name $a_html | safeHTML}} diff --git a/docs/layouts/partials/navbar-version-selector.html b/docs/layouts/partials/navbar-version-selector.html index 546086a14..7031d7208 100644 --- a/docs/layouts/partials/navbar-version-selector.html +++ b/docs/layouts/partials/navbar-version-selector.html @@ -9,11 +9,14 @@ {{ $.Scratch.Set "activeVersion" .version }} {{ end }} {{ end }} + +{{ if .Site.Params.versions }}
{{ range .Site.Params.versions }} + {{ if and .url (ne .url "") }} {{ end }} + {{ end }}
+{{ end }} diff --git a/docs/layouts/partials/sidebar.html b/docs/layouts/partials/sidebar.html index 254763f5b..50a599d49 100644 --- a/docs/layouts/partials/sidebar.html +++ b/docs/layouts/partials/sidebar.html @@ -18,7 +18,11 @@ @@ -49,11 +53,13 @@ {{ $page.LinkTitle }} {{ else }}
- {{ if $page.Params.externalLink }} + {{- if and $page.Params.externalLink (ne $page.Params.externalLink "") -}} {{ $page.LinkTitle }} - {{ else }} + {{- else if and $page.Permalink (ne $page.Permalink "") -}} {{ $page.LinkTitle }} - {{ end }} + {{- else -}} + {{ $page.LinkTitle }} + {{- end }} {{ if $page.Pages }}