fix: resolve dead links flagged by validate-docs CI job#1131
fix: resolve dead links flagged by validate-docs CI job#1131GrammaTonic merged 4 commits intodevelopfrom
Conversation
- 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)
Summary of ChangesHello, 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 Highlights
🧠 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
Activity
Using Gemini Code AssistThe 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
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 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
|
There was a problem hiding this comment.
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)
Summary
Fixes all dead links reported by the
validate-docsjob in the Docs & Wiki Validation workflow.Changes
.markdown-link-check.json- Strengthen ignore patterns:localhostpattern to reliably match all local URLsmailto:pattern to prevent false positives from@-containing package namescomputerhope.compattern for bot-blocked external sitedocs/features/PROMETHEUS_IMPROVEMENTS.md- Updated dead GitHub docs link to the current URLdocs/features/GRAFANA_DASHBOARD_METRICS.md- Replaced bot-blocked computerhope.com netcat link with man7.org ncat man pagedocs/releases/RELEASE_NOTES_v2.2.0.md- Changed bold tar@7.5.2 to backtick formatting to prevent mailto false positiveDead links resolved