palantir/blueprint

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

开放

#6,553 创建于 2023年11月15日

在 GitHub 查看贡献者指南
 (2 条评论) (0 个反应) (0 位负责人)TypeScript (2,167 个派生)batch import
Domain: documentationP1Type: bughelp wanted

仓库指标

星标
 (20,263 个星标)
PR 合并指标
 (平均合并 43天 10小时) (30 天内合并 27 个 PR)

描述

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

贡献者指南

研究方向
调查 Blueprint 文档生成流水线，可能使用 Typedoc 或自定义脚本。查看 @see 标签在属性接口表中的处理方式。检查仓库的文档配置文件和脚本（例如在 'docs' 或 'scripts' 目录中）。确定问题是出在标签解析还是链接渲染环节。一个潜在的修复方案可能涉及调整文档生成器的 JSDoc/TSDoc 解析器或渲染链接的模板。
技术栈
typescriptreact
领域
documentationfrontend
议题类型
缺陷
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
1
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1 小时以内
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
GitMarkdown
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
90