Skip to content

Normalize all headings in the Sphinx documentation#4324

Merged
alecgrieser merged 2 commits into
FoundationDB:mainfrom
RobertBrunel:docs-2
Jul 7, 2026
Merged

Normalize all headings in the Sphinx documentation#4324
alecgrieser merged 2 commits into
FoundationDB:mainfrom
RobertBrunel:docs-2

Conversation

@RobertBrunel

Copy link
Copy Markdown
Contributor
  • Normalize all headings to sentence case instead of Title Case.
  • Wrap SQL keywords, type names, and class/identifier names with typewriter-font markup.
  • Normalize imperative mood to gerund form (e.g., “Rename a record type” becomes “Renaming a record type”).

* Normalize all headings to sentence case instead of Title Case.
* Wrap SQL keywords, type names, and class/identifier names with typewriter-font markup.
* Normalize imperative mood to gerund form (e.g., “Rename a record type” becomes “Renaming a record type”).
@RobertBrunel RobertBrunel self-assigned this Jul 6, 2026
@RobertBrunel RobertBrunel added the documentation Documentation change label Jul 6, 2026

@arnaud-lacurie arnaud-lacurie left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Can you change the skill to recommend that sentence case be used for documentation?

@RobertBrunel RobertBrunel changed the title Normalize all headings in the docs/sphinx/ documentation Normalize all headings in the Sphinx documentation Jul 7, 2026
@alecgrieser alecgrieser merged commit ebc9a46 into FoundationDB:main Jul 7, 2026
13 checks passed
@RobertBrunel RobertBrunel deleted the docs-2 branch July 7, 2026 13:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Documentation change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants