Skip to content

fix(docs): fix links in documentation files#2956

Merged
revmag merged 4 commits intomainfrom
deadline-checker-fixes
Mar 24, 2026
Merged

fix(docs): fix links in documentation files#2956
revmag merged 4 commits intomainfrom
deadline-checker-fixes

Conversation

@revmag
Copy link
Collaborator

@revmag revmag commented Mar 24, 2026

No description provided.

@vercel
Copy link

vercel bot commented Mar 24, 2026

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

Project Deployment Actions Updated (UTC)
signoz-web Ready Ready Preview, Comment Mar 24, 2026 6:06am

Request Review

@claude
Copy link
Contributor

claude bot commented Mar 24, 2026

Claude finished @revmag's task in 2m 9s —— View job


Docs PR Review — fix(docs): fix links in documentation files

  • Gather context and read changed files
  • Review docs changes using docs review rubric
  • Post inline comments for issues found
  • Post summary

Summary

This PR fixes broken/incorrect links across 13 docs files. The link fixes are valid and helpful — notably fixing signoz.iohttps://signoz.io doubled URLs, a localhost:3000 link, and updating external URLs to their current locations.

P1 — Incorrect link target

  • otel-operator/overview.mdx: The "Annotations" link was changed from a broken localhost URL to install/#opentelemetry-collector, but that section covers the Collector CRD, not auto-instrumentation annotations. The correct target is configure/#auto-instrumentation-with-opentelemetry-operator. (inline comment)

P2 — Residual double trailing slashes

  • gcp-clb/logging.mdx: Both GCP links still have // trailing slashes (e.g. pubsub-topic-creation//), causing 308 redirects. These should be single /. (inline comment)

P3 — Date-only changes with no link fixes

  • inkeep-monitoring.mdx, aws-rds-postgres.mdx, and migrate-from-signoz-self-host-to-signoz-cloud.mdx only have date frontmatter bumped to today with no actual link fixes. Consider dropping these from the PR to keep the changeset focused.

Verified link changes (working correctly)

File Fix Status
nomad.mdx HashiCorp telemetry URL updated ✅ 200
crewai-observability.mdx / langchain-observability.mdx OpenInference URL updated ✅ 200
golang/manual-instrumentation.mdx Go docs go1.25.1go1.25 ✅ 200
heroku_logs_to_signoz.mdx docker-compose-minimal.yamldocker-compose.yaml ✅ 200
argocd-metrics.mdx community.signoz.iocommunity-chat.signoz.io ✅ (rate-limited but expected)

Checklist coverage

  • ✅ Link health — verified, 2 residual issues flagged above
  • ✅ No new docs files — onboarding label not needed
  • ✅ No sidebar/redirect changes needed
  • ⚠️ Anchor accuracy — 1 mismatch flagged

revmag and others added 3 commits March 24, 2026 11:25
Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
…erview.mdx

Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
@revmag revmag merged commit d67542e into main Mar 24, 2026
7 checks passed
@revmag revmag deleted the deadline-checker-fixes branch March 24, 2026 07:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants