Azure / Azure/azure-sdk-tools

Link checker should check .xml files as well

Open
#6,107 5 comments 0 reactions 0 assignees View on GitHub
Central-EngSys
Dominant language
C#
Stars
135
Forks
260
Avg merge
3d 1h
Merged PRs (30d)
143

Description

.NET uses .xml files for documentation, and we recently discovered some have broken (404) links. We should add .xml files to the link checker as well or, if too noisy for all language repos, make the file pattern list configurable per-repo.

See Azure/azure-sdk-for-net#36066 for context.

Contributor guide

Open the contributing guide

Research direction

No implementation file, test, or entry point is named. Start by locating the link checker's file-pattern list and any repository-specific configuration, then inspect how language repositories are selected. Done means XML documentation links are checked without unacceptable noise, or the file patterns can be configured per repository.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.