Skip to content

docs: normalize headings to sentence case#4018

Closed
cnaples79 wants to merge 2 commits intobeeware:mainfrom
cnaples79:fix-doc-title-case
Closed

docs: normalize headings to sentence case#4018
cnaples79 wants to merge 2 commits intobeeware:mainfrom
cnaples79:fix-doc-title-case

Conversation

@cnaples79
Copy link
Copy Markdown

Summary

  • apply sentence case to doc titles/headings for consistency with chosen style
  • replace tutorial phrase headings with concise, descriptive titles

Rationale

Changes

  • updated tutorial titles and index entries to descriptive sentence case
  • adjusted topic/reference/about headings (data sources, debugging, pack engine, image plugins, success stories, platforms) to sentence case

Test Plan

  • not run locally; docs-only change

Fixes #3819

Copy link
Copy Markdown
Member

@HalfWhitt HalfWhitt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, thanks for the contribution! This is currently failing the towncrier check; you'll need to add a change note.

@mhsmith
Copy link
Copy Markdown
Member

mhsmith commented Jan 7, 2026

The sidebar captions in SUMMARY.md should be updated to match the new titles. And there are a few more titles in there that you missed, such as "Release History" and "API Reference".

Copy link
Copy Markdown
Member

@HalfWhitt HalfWhitt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What mhsmith said, plus your changes to Pack and Image plugins — which I recommended not changing — are probably going to cause merge conflicts with #4022. I'd also recommend making the tutorial tutorial titles gerunds (with "-ing", e.g. "Organizing layouts").

Do you anticipate having the opportunity to finish work on this?

@HalfWhitt
Copy link
Copy Markdown
Member

Superceded by #4087

@HalfWhitt HalfWhitt closed this Feb 5, 2026
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.

Inconsistent title case in docs

3 participants