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.