Skip to content

Normalize docs titles to sentence case#4087

Closed
Nabhye wants to merge 6 commits intobeeware:mainfrom
Nabhye:fix-docs-titles
Closed

Normalize docs titles to sentence case#4087
Nabhye wants to merge 6 commits intobeeware:mainfrom
Nabhye:fix-docs-titles

Conversation

@Nabhye
Copy link
Copy Markdown
Contributor

@Nabhye Nabhye commented Jan 17, 2026

This PR standardizes documentation page titles and sidebar entries to use
sentence case, following the chosen documentation style.

Changes include:

  • Updated topic page titles to sentence case
  • Updated sidebar and topic index entries to match page titles
  • Preserved anchors and filenames to avoid breaking links

This resolves the inconsistency between title- and sentence-cased headings
in the docs.

@Nabhye
Copy link
Copy Markdown
Contributor Author

Nabhye commented Jan 17, 2026

This PR only updates documentation title capitalization.
No functional or code changes were made.

@mhsmith
Copy link
Copy Markdown
Member

mhsmith commented Jan 17, 2026

Thanks, but there are several other places that will need to be updated in order to completely fix #3819. Most of these can be found in #4018 or its comments.

Also, the PR will need to include a change note. For instructions, please follow the "Check towncrier" link at the bottom of the PR page.

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.

Thanks for adding the change note! Two things on that front:

  • Change notes should be phrased the way you'd expect to see them in release notes, e.g., "Feature X has been added" rather than "Add feature X".
  • The doc category is for actually substantial changes — things that would, in fact, warrant going in a version's release notes. For minor changes like this, misc is more appropriate.

Beyond that, as @mhsmith mentioned, there are more titles that are all capitalized, for example the three last pages under About Toga. And the tutorial titles, which are currently sentences / long phrases, need to be converted to simple, descriptive titles.

@Nabhye
Copy link
Copy Markdown
Contributor Author

Nabhye commented Jan 20, 2026

I’ve now updated the remaining About pages and converted tutorial titles to short, descriptive sentence-case titles, while avoiding sections likely to conflict. Please let me know if anything else should be adjusted.

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.

Thanks for updating the change note, that looks great.

I’ve now updated the remaining About pages and converted tutorial titles to short, descriptive sentence-case titles

It doesn't look like that's in here... your commit named Normalize remaining About and tutorial titles to sentence case doesn't include any changes other than deleting the doc change note. Perhaps you forgot to stage your files when committing?

Comment thread docs/en/topics/data-sources.md Outdated
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.

I'm not sure if you were planning to add more changes, but I notice that, similar to before, while your latest commit is named "Normalize remaining About and tutorial titles to sentence case", nothing's actually changed on the tutorials. (I see you have indeed fixed titles in About and Topics though, thank you.)

Once you're happy with how you have things and would like a re-review, feel free to leave a comment, or hit the refresh button next to where I'm listed as a reviewer.

@johnzhou721
Copy link
Copy Markdown
Contributor

Also: The towncrier template in changes/ should also be normalized to sentence case, and we may want to edit past release notes as well.

@HalfWhitt
Copy link
Copy Markdown
Member

Superseded by #4329.

@HalfWhitt HalfWhitt closed this Apr 15, 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

4 participants