Improve Concept Link Descriptions

Open
#1,502 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale

Research direction

Review the descriptions in concepts/**/links.json, starting with the time concept examples skeet-time-of-day and wiki-utc. Compare each cryptic reference-style description with its linked source, then update descriptions where naming Stack Overflow, Wikipedia, or another authority adds useful context while keeping them brief. Done means the link descriptions are clearer without unnecessary verbosity.

Written by the indexing model from the issue text.

Description

The descriptions for the links in concepts/**/links.json are based on the markdown arbitrary reference text for reference-style links. For the most part, these work well but some are a bit cryptic.

For instance, the time concept contains links described as skeet-time-of-day and wiki-utc. These are probably better as "time-of-day per Jon Skeet" and "Wikipedia on UTC".

I think brevity is an aspiration for the link descriptions but I think it's worth mentioning the source if it's Stack Overflow or Wikipedia or a well-known authority and their view is adding color to our description of the concept which is covered by more generic links.

Dominant language
C#
Stars
428
Forks
384
Avg merge
2d 2h
Merged PRs (30d)
5

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from exercism/csharp

All issues in exercism/csharp

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.