palantir/blueprint

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

Open

#6553 opened on Nov 15, 2023

View on GitHub
 (2 comments) (0 reactions) (0 assignees)TypeScript (20,263 stars) (2,167 forks)batch import
Domain: documentationP1Type: bughelp wanted

Description

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

Tech stack
typescriptreacthtmlcss
Domain
documentation
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
familiarity with TypeScript documentation generationunderstanding of @see TSDoc tags
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
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.