palantir/blueprint

[Minor] [Feature] Add proper <title>'s to the documentation pages.

Open

#1,829 建立於 2017年11月21日

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

描述

This is a minor feature request.

So I've been spending a lot of time on the documentation, and I often need to go back (in history). Right now every documentation page has the same <title> (Blueprint - Documentation). I think it would be neat to change the page title (the convention would be to use something like document.title to change the title of the documentation page). I think it would be neat to have the page title be something like "Blueprint - Button documentation" or "Blueprint | Tooltip docs". Whatever the preferred style is.

If this is something you want, I'm totally willing to work on this as a PR. Just let me know. 🤷🏽‍♂️

貢獻者指南

技術棧
typescriptreacthtmlcss
領域
documentationfrontend
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
1
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Basic JavaScript/TypeScriptReact
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
90
研究方向
Implement by adding a custom hook or utility that sets document.title based on the current documentation page. For example, in each documentation route component, call document.title = 'Blueprint <PageName>'. The specific files to modify are likely the React components for each documentation page. Refer to existing documentation pages like Button or Tooltip to understand the pattern. There are no linked PRs, so the contributor can propose the preferred title format like 'Blueprint Button Documentation'.