Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: unify title capitalization style #8973

Merged
merged 4 commits into from
Jan 8, 2025
Merged

docs: unify title capitalization style #8973

merged 4 commits into from
Jan 8, 2025

Conversation

chenjiahan
Copy link
Member

Summary

Added our writing style guide:

  • Capitalization style: page titles and section headings should use sentence-style capitalization (only capitalize the first word and proper nouns) rather than title-style capitalization:
    • Correct: "A new method for creating JavaScript rollovers"
    • Incorrect: "A New Method for Creating JavaScript Rollovers"

Reference

Wikipedia

Capitalize the initial letter (except in rare cases, such as eBay), but otherwise follow sentence case, not title case.

https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style#Article_titles,_sections,_and_headings

Microsoft Writing Style Guide

In general, use sentence-style casing (that is, only capitalize the first word of a title, like at the beginning of a sentence), as this makes content more readable and ensures better localizability.

https://learn.microsoft.com/en-us/style-guide/text-formatting/formatting-titles

MDN

Page titles and section headings should use sentence-style capitalization (only capitalize the first word and proper nouns) rather than headline-style capitalization.

https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Writing_style_guide#titles

WordPress

In most cases, sentence-case capitalization is used.

https://github.com/WordPress/WordPress-Documentation-Style-Guide/blob/main/docs/3-language-grammar/capitalization.md#title-case-capitalization

Checklist

  • Tests updated (or not required).
  • Documentation updated (or not required).

@github-actions github-actions bot added the release: document release: document related release(mr only) label Jan 8, 2025
Copy link

netlify bot commented Jan 8, 2025

Deploy Preview for rspack ready!

Name Link
🔨 Latest commit cbe9bc3
🔍 Latest deploy log https://app.netlify.com/sites/rspack/deploys/677e8f1d34e9150008ee1a5e
😎 Deploy Preview https://deploy-preview-8973--rspack.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@github-actions github-actions bot added the team The issue/pr is created by the member of Rspack. label Jan 8, 2025
@chenjiahan chenjiahan merged commit 203b7e9 into main Jan 8, 2025
29 checks passed
@chenjiahan chenjiahan deleted the title_casing_0108 branch January 8, 2025 23:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release: document release: document related release(mr only) team The issue/pr is created by the member of Rspack.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants