Skip to content

DOC-5945 first attempt at some AI metadata #2397

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 7 commits into from
Nov 17, 2025
+105 −1
Merged

DOC-5945 first attempt at some AI metadata #2397

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
fe0827a
DOC-5945 first attempt at some AI metadata
andy-stark-redis Nov 14, 2025
066585c
DOC-5945 added body metadata backup
andy-stark-redis Nov 14, 2025
6082430
DOC-5945 moved JSON content to body of element
andy-stark-redis Nov 14, 2025
3f077b6
DOC-5945 try adding command metadata
andy-stark-redis Nov 14, 2025
1060cfa
DOC-5945 add expanded metadata fields (acl_categories, since, arity, …
andy-stark-redis Nov 14, 2025
e52e337
DOC-5945 remove duplicate 'oss' categories from all command files (51…
andy-stark-redis Nov 14, 2025
5c83e8f
Revert "DOC-5945 remove duplicate 'oss' categories from all command f…
andy-stark-redis Nov 14, 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
6 changes: 5 additions & 1 deletion layouts/_default/baseof.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,9 @@
{{ partialCached "css.html" . }}

{{ block "head" . }}{{ end }}


{{ partial "ai-metadata.html" . }}

{{ partial "fonts.html" . }}

{{ if hugo.IsProduction -}}
Expand All @@ -56,6 +58,8 @@
{{ end }}
</head>
<body class="antialiased tracking-[-0.01em] bg-white w-full">
{{ partial "ai-metadata-body.html" . }}

{{ if hugo.IsProduction -}}
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id={{ .Site.Params.tagManagerId }}"
height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
Expand Down
18 changes: 18 additions & 0 deletions layouts/_default/section.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,22 @@
# {{ .Title }}

```json metadata
{
"title": "{{ .Title }}",
"description": "{{ .Description }}",
"categories": {{ .Params.categories | jsonify }}{{ if .Params.arguments }},
"arguments": {{ .Params.arguments | jsonify }}{{ end }}{{ if .Params.syntax_fmt }},
"syntax_fmt": {{ .Params.syntax_fmt | jsonify }}{{ end }}{{ if .Params.complexity }},
"complexity": {{ .Params.complexity | jsonify }}{{ end }}{{ if .Params.group }},
"group": {{ .Params.group | jsonify }}{{ end }}{{ if .Params.command_flags }},
"command_flags": {{ .Params.command_flags | jsonify }}{{ end }}{{ if .Params.acl_categories }},
"acl_categories": {{ .Params.acl_categories | jsonify }}{{ end }}{{ if .Params.since }},
"since": {{ .Params.since | jsonify }}{{ end }}{{ if .Params.arity }},
"arity": {{ .Params.arity | jsonify }}{{ end }}{{ if .Params.key_specs }},
"key_specs": {{ .Params.key_specs | jsonify }}{{ end }}
}
```

{{ $content := .RawContent }}

{{/* Fix relrefs */}}
Expand Down
18 changes: 18 additions & 0 deletions layouts/_default/single.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,22 @@
# {{ .Title }}

```json metadata
{
"title": "{{ .Title }}",
"description": "{{ .Description }}",
"categories": {{ .Params.categories | jsonify }}{{ if .Params.arguments }},
"arguments": {{ .Params.arguments | jsonify }}{{ end }}{{ if .Params.syntax_fmt }},
"syntax_fmt": {{ .Params.syntax_fmt | jsonify }}{{ end }}{{ if .Params.complexity }},
"complexity": {{ .Params.complexity | jsonify }}{{ end }}{{ if .Params.group }},
"group": {{ .Params.group | jsonify }}{{ end }}{{ if .Params.command_flags }},
"command_flags": {{ .Params.command_flags | jsonify }}{{ end }}{{ if .Params.acl_categories }},
"acl_categories": {{ .Params.acl_categories | jsonify }}{{ end }}{{ if .Params.since }},
"since": {{ .Params.since | jsonify }}{{ end }}{{ if .Params.arity }},
"arity": {{ .Params.arity | jsonify }}{{ end }}{{ if .Params.key_specs }},
"key_specs": {{ .Params.key_specs | jsonify }}{{ end }}
}
```

{{ $content := .RawContent }}

{{/* Fix relrefs */}}
Expand Down
32 changes: 32 additions & 0 deletions layouts/partials/ai-metadata-body.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{{- /* Generate AI-friendly metadata as a hidden div in the page body */ -}}
{{- $metadata := dict "title" .Title "description" .Description "categories" .Params.categories -}}
{{- if .Params.arguments -}}
{{- $metadata = merge $metadata (dict "arguments" .Params.arguments) -}}
{{- end -}}
{{- if .Params.syntax_fmt -}}
{{- $metadata = merge $metadata (dict "syntax_fmt" .Params.syntax_fmt) -}}
{{- end -}}
{{- if .Params.complexity -}}
{{- $metadata = merge $metadata (dict "complexity" .Params.complexity) -}}
{{- end -}}
{{- if .Params.group -}}
{{- $metadata = merge $metadata (dict "group" .Params.group) -}}
{{- end -}}
{{- if .Params.command_flags -}}
{{- $metadata = merge $metadata (dict "command_flags" .Params.command_flags) -}}
{{- end -}}
{{- if .Params.acl_categories -}}
{{- $metadata = merge $metadata (dict "acl_categories" .Params.acl_categories) -}}
{{- end -}}
{{- if .Params.since -}}
{{- $metadata = merge $metadata (dict "since" .Params.since) -}}
{{- end -}}
{{- if .Params.arity -}}
{{- $metadata = merge $metadata (dict "arity" .Params.arity) -}}
{{- end -}}
{{- if .Params.key_specs -}}
{{- $metadata = merge $metadata (dict "key_specs" .Params.key_specs) -}}
{{- end -}}
{{- $json := $metadata | jsonify -}}
{{- printf `<div hidden data-redis-metadata="page">%s</div>` $json | safeHTML -}}

32 changes: 32 additions & 0 deletions layouts/partials/ai-metadata.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{{- /* Generate AI-friendly metadata as JSON in a script tag for the header */ -}}
{{- $metadata := dict "title" .Title "description" .Description "categories" .Params.categories -}}
{{- if .Params.arguments -}}
{{- $metadata = merge $metadata (dict "arguments" .Params.arguments) -}}
{{- end -}}
{{- if .Params.syntax_fmt -}}
{{- $metadata = merge $metadata (dict "syntax_fmt" .Params.syntax_fmt) -}}
{{- end -}}
{{- if .Params.complexity -}}
{{- $metadata = merge $metadata (dict "complexity" .Params.complexity) -}}
{{- end -}}
{{- if .Params.group -}}
{{- $metadata = merge $metadata (dict "group" .Params.group) -}}
{{- end -}}
{{- if .Params.command_flags -}}
{{- $metadata = merge $metadata (dict "command_flags" .Params.command_flags) -}}
{{- end -}}
{{- if .Params.acl_categories -}}
{{- $metadata = merge $metadata (dict "acl_categories" .Params.acl_categories) -}}
{{- end -}}
{{- if .Params.since -}}
{{- $metadata = merge $metadata (dict "since" .Params.since) -}}
{{- end -}}
{{- if .Params.arity -}}
{{- $metadata = merge $metadata (dict "arity" .Params.arity) -}}
{{- end -}}
{{- if .Params.key_specs -}}
{{- $metadata = merge $metadata (dict "key_specs" .Params.key_specs) -}}
{{- end -}}
{{- $json := $metadata | jsonify -}}
{{- printf `<script type="application/json" data-ai-metadata>%s</script>` $json | safeHTML -}}