palantir/blueprint

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

Open

#6553 aperta il 15 nov 2023

Vedi su GitHub
 (2 commenti) (0 reazioni) (0 assegnatari)TypeScript (2167 fork)batch import
Domain: documentationP1Type: bughelp wanted

Metriche repository

Star
 (20.263 star)
Metriche merge PR
 (Merge medio 24g 18h) (17 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Indaga sulla pipeline di generazione della documentazione di Blueprint, probabilmente utilizzando Typedoc o uno script personalizzato. Esamina come i tag @see vengono elaborati nelle tabelle delle interfacce delle proprietà. Controlla i file di configurazione e gli script della documentazione nel repository (ad es. nelle directory 'docs' o 'scripts'). Identifica se il problema risiede nell'analisi dei tag o nel rendering dei link. Una potenziale soluzione potrebbe coinvolgere la modifica del parser JSDoc/TSDoc del generatore di documentazione o del modello che renderizza i link.
Tech stack
typescriptreact
Dominio
documentationfrontend
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
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
GitMarkdown
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90