CommunityToolkit/WindowsCommunityToolkit

Links in XML comments need updating

Open

#3,831 opened on Mar 11, 2021

View on GitHub
 (5 comments) (0 reactions) (0 assignees)C# (1,403 forks)batch import
Hacktoberfestbug :bug:documentation :page_with_curl:good first issue

Repository metrics

Stars
 (5,708 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Describe the bug

We need to update our XML comments to have better standards for when they're generated into docs:

  • ideally use a typed reference vs. a specific url link
  • use https instead of http
  • not include locale like en-us in the link url
  • don't link to specific views with query-strings to docs

Contributor guide

Research direction
Update XML comments to use typed references, HTTPS, remove locale and query strings.
Tech stack
csharp
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90