palantir/blueprint

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

Offen

#6.553 geöffnet am 15.11.2023

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

Repository-Metriken

Stars
 (20.263 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

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

Research-Richtung
Untersuche die Blueprint Dokumentationsgenerierungs Pipeline, die wahrscheinlich Typedoc oder ein benutzerdefiniertes Skript verwendet. Prüfe, wie @see Tags in den Eigenschafts Interface Tabellen verarbeitet werden. Untersuche die Dokumentationskonfigurationsdateien und Skripte des Repositorys (z. B. im Verzeichnis 'docs' oder 'scripts'). Stelle fest, ob das Problem beim Tag Parsing oder beim Link Rendering liegt. Eine mögliche Lösung könnte die Anpassung des JSDoc/TSDoc Parsers des Dokumentationsgenerators oder der Vorlage, die die Links rendert, beinhalten.
Tech Stack
typescriptreact
Domain
documentationfrontend
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitMarkdown
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90