Skip to content

Render docs nav labels as their authors wrote them - #5621

Open
dimitrieh wants to merge 1 commit into
docs/prev-next-linksfrom
docs/nav-title-case
Open

Render docs nav labels as their authors wrote them#5621
dimitrieh wants to merge 1 commit into
docs/prev-next-linksfrom
docs/nav-title-case

Conversation

@dimitrieh

Copy link
Copy Markdown
Contributor

Description

Stacked on #5620, which this depends on. GitHub retargets it to main once that merges.

The docs sidebar capitalised every word, which altered 42 of its 117 labels. Installing a license read as Installing A License, Upgrading the Node-RED version as Upgrading The Node-RED Version, and Bosch Rexroth's ctrlX as CtrlX on the two hardware pages named after it.

The rule existed to make a section named after its directory look like a word, turning install into Install. After #5620 those labels come from the section's own navTitle, so nothing needs the transform and everything else was collateral damage. Breadcrumbs carried the same capitalize on the same authored titles, so that goes too.

Only the docs sidebar renders .handbook-nav: the handbook has its own component and markup, and no page uses the Eleventy layout that shared the class.

Verified in the browser at 1280px: computed text-transform is now none, and the labels above render as authored.

Related Issue(s)

None.

Checklist

  • I have read the contribution guidelines
  • I have considered the performance impact of these changes
  • Suitable unit/system level tests have been added and they pass
  • Documentation has been updated
  • For blog PRs, an Art Request has been created (instructions)

The docs sidebar capitalised every word, which altered 42 of its 117 labels:
"Installing a license" read as "Installing A License", "Upgrading the Node-RED
version" as "Upgrading The Node-RED Version", and Bosch Rexroth's ctrlX as
CtrlX on the two hardware pages named after it.

The rule was there to make a section named after its directory look like a word,
turning "install" into "Install". Those labels now come from the section's own
navTitle, so nothing needs the transform and everything else was collateral.

Breadcrumbs carried the same `capitalize`, on the same authored titles, so it
goes too.

Only the docs sidebar renders `.handbook-nav`: the handbook has its own
component with its own markup, and the Eleventy layout that shared the class is
no longer used by any page.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant