chocolatey / chocolatey/choco

Assess the repository links and use relative links where feasible

Open
#3,535 0 comments 0 reactions 0 assignees View on GitHub
0 - Triaging Documentation
Dominant language
C#
Stars
11.5k
Forks
960
PR merge metrics
No merged PRs in 30d

Description

### Checklist

- [X] I have verified this is the correct repository for opening this issue.
- [X] I have verified no other issues exist related to my request.

### Is Your Feature Request Related To A Problem? Please describe.

_No response_

### Describe The Solution. Why is it needed?

A number of the links in various markdown files are absolute links to files on either the master of develop branch of the repository. Where it's appropriate we should consider using relative links.

### Additional Context

As noted, some go to master and others go to develop. I think this is intentional, and possibly desired for some of the links. It seemed that the ones that went to master were around licensing and the libraries used by Chocolatey CLI, which I think makes sense as people interested in those are likely looking for information on the released product.

### Related Issues

_No response_

Contributor guide

Open the contributing guide

Research direction

Start by inventorying the absolute repository links across the markdown files and compare links targeting the master and develop branches. Review the licensing and library-related links separately, then update only links that can safely be relative; done means the appropriate links are relative without changing intentional release-oriented destinations.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.