palantir/blueprint

BP doc's @see links in props interface tables are broken

Open

#6 553 ouverte le 15 nov. 2023

Voir sur GitHub
 (2 commentaires) (0 réactions) (0 assignés)TypeScript (20 263 stars) (2 167 forks)batch import
Domain: documentationP1Type: bughelp wanted

Description

Environment

  • Package version(s):
  • Operating System:
  • Browser name and version:

Code Sandbox

Link to a minimal repro (fork this code sandbox):

Steps to reproduce

https://blueprintjs.com/docs/#core/components/popover image

Actual behavior

Expected behavior

Possible solution

Guide contributeur

Stack technique
typescriptreacthtmlcss
Domaine
documentation
Type d'issue
bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
under 1 hour
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
fresh
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
familiarity with TypeScript documentation generationunderstanding of @see TSDoc tags
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85
Direction de recherche
Investigate the Blueprint documentation generation pipeline, likely using Typedoc or a custom script. Look for how @see tags are processed in props interface tables. Examine the repository's documentation configuration files and scripts (e.g., in the 'docs' or 'scripts' directory). Identify if the issue is in the tag parsing or link rendering. A potential fix may involve adjusting the documentation generator's JSDoc/TSDoc parser or the template that renders the links.