palantir/blueprint

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

Open

#6,553 建立於 2023年11月15日

在 GitHub 查看
 (2 留言) (0 反應) (0 負責人)TypeScript (20,263 star) (2,167 fork)batch import
Domain: documentationP1Type: bughelp wanted

描述

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

貢獻者指南

技術棧
typescriptreacthtmlcss
領域
documentation
議題類型
bug
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
familiarity with TypeScript documentation generationunderstanding of @see TSDoc tags
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
85
研究方向
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.