pastelsky/tsdocs

Relative links in readme can be broken

Open

#9 aperta il 19 dic 2023

Vedi su GitHub
 (12 commenti) (2 reazioni) (0 assegnatari)TypeScript (26 fork)github user discovery
good first issue

Metriche repository

Star
 (1124 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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.

Guida contributor

Direzione di ricerca
Indaga come lo strumento gestisce attualmente il rendering del README. Cerca parser Markdown o logica di trasformazione dei link. Identifica dove i link relativi non vengono risolti in URL assoluti. Proponi una correzione che risolva i link relativi rispetto all'URL di base del repository o alla pagina del pacchetto npm.
Tech stack
typescript
Dominio
documentationdeveloper experience
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
TypeScriptMarkdown
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75