Should references to markdown files point to the GitHub link or use relative paths? #20847

Closed
opened 2026-01-31 07:25:44 +00:00 by claunia · 2 comments
Owner

Originally created by @marcelwgn on GitHub (Nov 19, 2023).

Currently, README.md and other files point the GitHub.com link whenever referencing another markdown file that is part of this repository. Other repositories such as the WinUI repository have chosen to use relative links which would also allow browsing the files on your local machine without a browser opening.

Would this be a welcome change to the documentation or should we keep things as is?

If the former is the case, I would gladly contribute these changes.

Originally created by @marcelwgn on GitHub (Nov 19, 2023). Currently, README.md and other files point the GitHub.com link whenever referencing another markdown file that is part of this repository. Other repositories such as the WinUI repository have chosen to use relative links which would also allow browsing the files on your local machine without a browser opening. Would this be a welcome change to the documentation or should we keep things as is? If the former is the case, I would gladly contribute these changes.
claunia added the Help WantedPriority-3In-PRNeeds-Tag-FixIssue-Docs labels 2026-01-31 07:25:44 +00:00
Author
Owner

@lhecker commented on GitHub (Nov 21, 2023):

Yes, I believe that change would be fine.

@lhecker commented on GitHub (Nov 21, 2023): Yes, I believe that change would be fine.
Author
Owner

@DHowett commented on GitHub (Nov 21, 2023):

Relative would be great! Thank you for asking 😄

@DHowett commented on GitHub (Nov 21, 2023): Relative would be great! Thank you for asking :smile:
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/terminal#20847