palantir/blueprint

docs: view source link is broken for htmlSelectExample

Open

#6296 opened on Jul 21, 2023

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

Description

View source on GitHub link for HTMLSelectExample page is broken:

leads to hTMLSelectExample.tsx (with only the first letter in lowercase) instead of htmlSelectExample.tsx.

Looks like this is due to https://github.com/palantir/blueprint/blob/d73a4055f2b5f45b1042fd838a1ce2127d5088c6/packages/docs-app/src/tags/reactExamples.ts#L37

Steps to reproduce

  1. go to https://blueprintjs.com/docs/#core/components/html-select
  2. click "View source on GitHub"
  3. observe that it leads to a non-existent file

Actual behavior

Expected behavior

Possible solution

Not sure if we should make an exception for this example only, and I figure it would break for other uppercase example files that could be added in the future.

Contributor guide

Tech stack
typescriptreact
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
none
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
The broken link is due to a case mismatch in the filename in `packages/docs app/src/tags/reactExamples.ts` at line 37. The fix is to change 'hTMLSelectExample.tsx' to 'htmlSelectExample.tsx'. However, consider a more robust approach, such as normalizing filenames to lowercase or using a mapping to avoid similar issues with other uppercase example files.