pastelsky/tsdocs

Relative links in readme can be broken

Open

#9 ouverte le 19 déc. 2023

Voir sur GitHub
 (12 commentaires) (2 réactions) (0 assignés)TypeScript (26 forks)github user discovery
good first issue

Métriques du dépôt

Stars
 (1 124 stars)
Métriques de merge PR
 (Métriques PR en attente)

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.

Guide contributeur

Direction de recherche
Enquêtez sur la façon dont l'outil gère actuellement le rendu du README. Cherchez des analyseurs Markdown ou une logique de transformation de liens. Identifiez où les liens relatifs ne sont pas résolus en URL absolues. Proposez un correctif qui résout les liens relatifs par rapport à l'URL de base du dépôt ou à la page du package npm.
Stack technique
typescript
Domaine
documentationdeveloper experience
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
TypeScriptMarkdown
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75