palantir/blueprint

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

Open

#1,829 opened on Nov 21, 2017

View on GitHub
 (3 comments) (0 reactions) (0 assignees)TypeScript (20,263 stars) (2,167 forks)batch import
Domain: documentationP2Type: feature requesthelp wanted

Description

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. 🤷🏽‍♂️

Contributor guide

Tech stack
typescriptreacthtmlcss
Domain
documentationfrontend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic JavaScript/TypeScriptReact
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
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'.