pastelsky/tsdocs

Relative links in readme can be broken

Open

#9 opened on Dec 19, 2023

View on GitHub
 (12 comments) (2 reactions) (0 assignees)TypeScript (26 forks)github user discovery
good first issue

Repository metrics

Stars
 (1,124 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

From HN:

Consider showing files other than the README. Relative links to things like CONTRIBUTING.md currently break. Alternatively interpret all relative links as pointing to github.com or npmjs.com. It'd be great to have a way to link from the README into API docs to guide readers. The community doesn't have a great convention for this unfortunately.

Contributor guide

Research direction
Investigate how the tool currently handles README rendering. Look for Markdown parsers or link transformation logic. Identify where relative links are not being resolved to absolute URLs. Propose a fix that resolves relative links against the repository's base URL or the npm package page.
Tech stack
typescript
Domain
documentationdeveloper experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
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
TypeScriptMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75