palantir/blueprint

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

Open

#6.553 geöffnet am 15. Nov. 2023

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (20.263 Stars) (2.167 Forks)batch import
Domain: documentationP1Type: bughelp wanted

Beschreibung

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

Contributor Guide

Tech Stack
typescriptreacthtmlcss
Domain
documentation
Issue Type
bug
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
under 1 hour
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
fresh
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
familiarity with TypeScript documentation generationunderstanding of @see TSDoc tags
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85
Research-Richtung
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.