Skip to content

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

Draft
dimitrieh wants to merge 2 commits into
mainfrom
docs/nav-title-case
Draft

dimitrieh wants to merge 2 commits into
mainfrom
docs/nav-title-case

Conversation

@dimitrieh

@dimitrieh dimitrieh commented Aug 17, 2026 •

Copy link
Copy Markdown
Contributor

Description

The docs sidebar capitalised every word, which altered 42 of its 117 labels. Installing a license read as Installing A License, and Bosch Rexroth's ctrlX as CtrlX.

The rule existed to make a section named after its directory look like a word, turning install into Install. Section labels now come from the section's own navTitle, so nothing needs the transform. Breadcrumbs carried the same capitalize on the same authored titles, so that goes too.

Two files: drop text-transform: capitalize from .handbook-nav, drop class="capitalize" from Breadcrumbs.vue.

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

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)

@dimitrieh
dimitrieh force-pushed the docs/prev-next-links branch from 4a4cb57 to 9fd27c8 Compare September 8, 2026 15:41
Base automatically changed from docs/prev-next-links to main September 10, 2026 14:11
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.
@netlify

netlify Bot commented Sep 10, 2026 •

Copy link
Copy Markdown

👷 Deploy Preview for flowfuse-website processing.

Name Link
🔨 Latest commit f51f596
🔍 Latest deploy log https://app.netlify.com/projects/flowfuse-website/deploys/6ab6c96b250e9f00080838ce

@dimitrieh
dimitrieh marked this pull request as draft September 25, 2026 19:27
@dimitrieh
dimitrieh removed the request for review from KristopherLeads September 25, 2026 19:27
@dimitrieh

Copy link
Copy Markdown
Contributor Author

FYI: the failing build here isn't caused by this PR. Tracked in https://github.com/FlowFuse/engineering/issues/460. It's resolved now, re-running the checks.

This branch was successfully deployed

1 active (outdated) deployment
Preview — fdc1c377 Deployed Sep 10, 2026 by github-actions[bot]
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