Skip to content

fix: resolve dead links flagged by validate-docs CI job#1131

Merged
GrammaTonic merged 4 commits intodevelopfrom
fix/validate-docs-dead-links
Mar 1, 2026
Merged

fix: resolve dead links flagged by validate-docs CI job#1131
GrammaTonic merged 4 commits intodevelopfrom
fix/validate-docs-dead-links

Conversation

@GrammaTonic
Copy link
Owner

Summary

Fixes all dead links reported by the validate-docs job in the Docs & Wiki Validation workflow.

Changes

.markdown-link-check.json - Strengthen ignore patterns:

  • Simplified localhost pattern to reliably match all local URLs
  • Broadened GitHub user URL pattern to cover all user-scoped pages
  • Added mailto: pattern to prevent false positives from @-containing package names
  • Added computerhope.com pattern for bot-blocked external site

docs/features/PROMETHEUS_IMPROVEMENTS.md - Updated dead GitHub docs link to the current URL

docs/features/GRAFANA_DASHBOARD_METRICS.md - Replaced bot-blocked computerhope.com netcat link with man7.org ncat man page

docs/releases/RELEASE_NOTES_v2.2.0.md - Changed bold tar@7.5.2 to backtick formatting to prevent mailto false positive

Dead links resolved

Link Status Fix
mailto:tar@7.5.2 400 (false positive) Backtick formatting + mailto ignore
computerhope.com/unix/nc.htm 403 (bot-blocked) Replaced + ignore pattern
github.com/users/.../projects/5 404 (private) Broadened ignore pattern
localhost:9090/3000/9091-3 0 (unreachable) Simplified ignore pattern
docs.github.com monitoring URL 404 (URL moved) Updated to current URL

- Strengthen .markdown-link-check.json ignore patterns: simplify
  localhost and GitHub user project patterns, add mailto: and
  computerhope.com patterns
- Fix dead GitHub docs URL in PROMETHEUS_IMPROVEMENTS.md (moved to
  /en/actions/how-tos/manage-runners/self-hosted-runners/monitor-and-troubleshoot)
- Replace bot-blocked computerhope.com link in GRAFANA_DASHBOARD_METRICS.md
  with man7.org ncat page
- Escape tar@7.5.2 in RELEASE_NOTES_v2.2.0.md to prevent false mailto
  detection (bold → backtick formatting)
@gemini-code-assist
Copy link

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request addresses and resolves all dead links identified by the validate-docs CI job. It improves the robustness of the documentation link validation process by refining ignore patterns and directly correcting broken or problematic links within the documentation files, ensuring the integrity and accessibility of referenced resources.

Highlights

  • Link Validation Configuration: Strengthened ignore patterns in .markdown-link-check.json to improve accuracy, including broader matches for localhost and GitHub user URLs, and new patterns for mailto: and computerhope.com.
  • Documentation Link Updates: Corrected a dead GitHub documentation link in docs/features/PROMETHEUS_IMPROVEMENTS.md to its current URL.
  • External Link Replacement: Replaced a bot-blocked computerhope.com link with a reliable man7.org link in docs/features/GRAFANA_DASHBOARD_METRICS.md.
  • Formatting Correction: Adjusted the formatting of tar@7.5.2 in docs/releases/RELEASE_NOTES_v2.2.0.md from bold to backticks to prevent a mailto: false positive during link validation.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • .markdown-link-check.json
    • Simplified the localhost pattern to match all local URLs.
    • Broadened the GitHub user URL pattern to cover all user-scoped pages.
    • Added a mailto: pattern to prevent false positives from @-containing package names.
    • Added a computerhope.com pattern for a bot-blocked external site.
  • docs/features/GRAFANA_DASHBOARD_METRICS.md
    • Replaced a link to computerhope.com/unix/nc.htm with man7.org/linux/man-pages/man1/ncat.1.html.
  • docs/features/PROMETHEUS_IMPROVEMENTS.md
    • Updated the GitHub Actions Monitoring link from docs.github.com/en/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners to docs.github.com/en/actions/how-tos/manage-runners/self-hosted-runners/monitor-and-troubleshoot.
  • docs/releases/RELEASE_NOTES_v2.2.0.md
    • Changed the formatting of tar@7.5.2 from bold (**tar@7.5.2**) to backticks (`tar@7.5.2`).
Activity
  • No human activity has occurred on this pull request yet.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request resolves several dead links flagged by the CI job. The changes involve strengthening ignore patterns for the link checker, updating outdated URLs in documentation, and adjusting markdown formatting to prevent false positives. Overall, the changes are effective in fixing the reported issues. I have one suggestion to improve the accuracy of a link replacement to ensure it matches the tool referenced in the code examples.

CHROME_RUNNER_X86_DEPLOYMENT.md:
- Merge two H1 headings into one (MD025)
- Fix heading increment h1→h4 to h1→h2→h3 (MD001)
- Add blank lines around headings and fenced blocks (MD022, MD031)

BRANCH_PROTECTION_GUIDE.md:
- Remove duplicate H1 / empty fenced block (MD025, MD040)
- Fix heading increment h1→h3 to numbered list item (MD001)
- Add blank lines around fenced blocks (MD031)
Add blank lines after headings and before fenced code blocks to resolve
remaining MD022, MD031, and MD032 markdownlint errors (lines 33-81).
- Auto-fix 656+ lint errors (MD009, MD022, MD031, MD032, MD047)
- Disable noisy rules in .markdownlint-cli2.jsonc (MD025, MD029, MD036, MD040, MD060)
- Fix heading increment violations (MD001) in chrome-runner, DEPLOYMENT, GRAFANA_DASHBOARD_METRICS, Installation-Guide
- Fix duplicate headings (MD024) in SETUP_SUMMARY and Installation-Guide
- Fix broken code block structure in SETUP_SUMMARY.md
- Update dead links: computerhope→man7.org, docs.github.com monitoring URL
- Strengthen .markdown-link-check.json ignore patterns

Verified locally: 0 errors across 46 files (markdownlint-cli2 v0.21.0)
@GrammaTonic GrammaTonic merged commit 26f6e6c into develop Mar 1, 2026
22 checks passed
@GrammaTonic GrammaTonic deleted the fix/validate-docs-dead-links branch March 1, 2026 22:35
@GrammaTonic GrammaTonic mentioned this pull request Mar 1, 2026
3 tasks
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.

1 participant