Skip to content

docs(llm): add query-matched meta_title to Ollama and Hermes - #4117

Open
gkarthi-signoz wants to merge 1 commit into
mainfrom
llm-docs-meta-titles-ollama-hermes
Open

docs(llm): add query-matched meta_title to Ollama and Hermes#4117
gkarthi-signoz wants to merge 1 commit into
mainfrom
llm-docs-meta-titles-ollama-hermes

Conversation

@gkarthi-signoz

@gkarthi-signoz gkarthi-signoz commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Pull Request


📄 Summary

Adds meta_title to two LLM docs whose current titles do not contain the words people actually search for.

This is deliberately two pages, not fifty-two. The controlled meta_title experiment on 11 guides (#3904, merged 2026-08-06) has now had three reads and shows no measurable CTR effect: difference-in-differences of -0.013 pp with a 95% CI of [-0.41, +0.38]. Populating the field is not the lever. Matching the query is, and only a handful of pages have a measured gap worth closing.

Both changes come from GSC page,query data over the last 90 days, restricted to reachable queries (machine fan-out, site: operators and below-position-20 queries excluded).

ollama-monitoring

Current title is Ollama Monitoring & Observability with OpenTelemetry. It contains neither "telemetry" as a standalone word nor "metrics", which together are 532 of 1,383 reachable attributable impressions.

Query Impressions Position
ollama telemetry 240 3.8
ollama monitoring 216 5.9
ollama metrics 169 7.7
ollama monitor 139 7.2

New: Ollama Monitoring: Telemetry and Metrics

hermes-monitoring

Current title is Hermes Monitoring and Observability with OpenTelemetry. The word "agent" appears in 414 of 760 reachable attributable impressions (54%) and is absent from the title entirely.

Query Impressions Position
hermes agent observability 98 4.2
hermes agent telemetry 97 4.4
hermes observability 90 1.9
hermes telemetry 64 5.0
hermes agent monitoring 56 6.3

New: Hermes Agent Observability and Telemetry

Both render at 54 characters including the | SigNoz Docs template suffix from app/(site)/docs/layout.tsx, so neither truncates in the SERP. The current titles render at 66 and 68 and do truncate.

Screenshots / Screen Recordings (if applicable)

N/A. Frontmatter-only change; no visual surface is affected. The meta_title field is consumed by generateMetadata in app/(site)/docs/(main-docs)/[...slug]/page.tsx and appears only in the <title> tag, not on the rendered page. The on-page H1 still comes from title and is unchanged.

Issues closed by this PR

None.


✅ Change Type

Select all that apply

  • ✨ Feature
  • 🐛 Bug fix
  • ♻️ Refactor
  • 🛠️ Infra / Tooling
  • 🧪 Test-only

Documentation metadata. None of the above categories fit cleanly.


🐛 Bug Context

N/A. Not a bug fix.


Both pages surface for query clusters their titles do not contain. Adding a
meta_title so the SERP title matches measured demand; page content, H1 and
date are unchanged, which is why this carries [skip-date].

Ollama: "telemetry" accounts for 333 of 1,383 reachable attributable
impressions and "metrics" another 199, neither of which appears in the
current title. Top query is "ollama telemetry" (240 impressions, position
3.8).

Hermes: "agent" appears in 414 of 760 reachable attributable impressions,
54%, and is absent from the current title. Top query is "hermes agent
observability" (98 impressions, position 4.2).

Both render at 54 characters including the "| SigNoz Docs" template suffix,
so neither truncates in the SERP.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01CfN43Qo1RE1kqQGGyhcCEB
@vercel

vercel Bot commented Sep 3, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
Project Deployment Actions Updated
signoz-web Ignored Ignored Preview Sep 3, 2026 7:35pm UTC

Request Review

@github-actions

github-actions Bot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Claude finished @gkarthi-signoz's task in 1m 19s —— View job


Docs PR Review

  • Read review playbooks (contributing/docs-review.md, docs-authoring.md)
  • Inspect changed frontmatter in both MDX files
  • Verify claims (title lengths, frontmatter parse, quoting, consumption path)
  • Post findings + summary

Frontmatter-only change adding meta_title to two existing LLM docs. I verified the mechanism and the PR's core claims independently.

Findings by severity

P1 / P2: None.

P3 (non-blocking, no action required):

  • Dropping "OpenTelemetry" from both rendered titles is a real trade, not a free win. The PR already quantifies it (≈5:1 for Ollama, ≈4:1 for Hermes in favour of the gained queries) and commits to re-checking at the next read. Flagging only so it stays on the radar, not as a change request.

Verification

  • Consumption path confirmed: meta_title is read in generateMetadata at app/(site)/docs/(main-docs)/[...slug]/page.tsx:25const seoTitle = post?.meta_title || post?.title — so it affects only the <title> tag. The on-page H1 (from title) is unchanged. The meta_title field is surfaced through utils/mdxUtils.ts (meta_title: doc.meta_title). Mechanism is real; this is not a no-op.
  • YAML parse: Both values are quoted. The colon in "Ollama Monitoring: Telemetry and Metrics" is safely inside quotes, so the parse hazard the author called out is handled.
  • Rendered <title> length: Both are 40 chars of body + 14 for | SigNoz Docs = 54 chars, under the SERP truncation threshold. The claim holds.

Personas and fit

Both pages serve platform/AI engineers instrumenting local LLM (Ollama) and autonomous-agent (Hermes) workloads. The change only tunes the search-result title toward the queries those personas actually type ("telemetry"/"metrics" for Ollama, "agent" for Hermes). No content or persona fit is altered.

JTBD coverage

Not applicable in the usual sense — no body, steps, validation, or links changed. The one relevant check (rendered title leads with the primary keyword, no brand suffix in the authored value) passes for both.

Checklist coverage (docs-authoring.md)

  • date intentionally not bumped; [skip-date] present and the rationale (pages inside a measurement window) is sound.
  • All other required frontmatter unchanged and intact.
  • No links, images, redirects, sidebar, or discovery surfaces are affected.

Open questions / assumptions

  • I could not run yarn check:docs-metadata in this environment (sandbox blocked the ad-hoc verification command), so I relied on static inspection. The allowedKeys gap the author noted (hasOnlyTitleAndDescriptionChanges at scripts/check-docs-metadata.js:236 omits meta_title) is correctly scoped out of this PR — worth a follow-up so future meta_title-only edits don't trip date enforcement.

Onboarding label: skipped

Both files are status == "modified" (edits to existing docs, not new pages). Per the onboarding policy, edits to existing docs never qualify.


LGTM — clean, low-risk, well-scoped, and the claims check out. No blocking issues.
· llm-docs-meta-titles-ollama-hermes

@github-actions

github-actions Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

CMS Sync Successful

Content has been synced to Strapi CMS with deployment status: staging

📊 Summary

Operation Count
✅ Created 0
🔄 Updated 2
🗑️ Deleted 0
⏭️ Skipped 0

🔗 Relations

The following relations were automatically resolved:

  • authors
  • tags
  • keywords

📄 Processed Documents

View 2 document(s)
Operation Route
Updated /hermes-monitoring
Updated /ollama-monitoring

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants