Skip to content
This repository was archived by the owner on Apr 6, 2023. It is now read-only.
/frameworkPublic archive

docs: ensure consistent casing of section headers - #6578

Merged
pi0 merged 2 commits into
nuxt:mainfrom
DamianGlowala:main
Aug 13, 2022
Merged

docs: ensure consistent casing of section headers#6578
pi0 merged 2 commits into
nuxt:mainfrom
DamianGlowala:main

Conversation

@DamianGlowala

Copy link
Copy Markdown
Member

🔗 Linked issue

❓ Type of change

  • 📖 Documentation (updates to the documentation or readme)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • 👌 Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

Knock knock, case police, let's make the case consistent, PLEASE! ;)

  • General inspiration for introducing consistency across the headers came from the Vue.js documentation.
  • Whenever in doubt, I followed the Wikipedia Manual of Style available as one of the options at https://capitalizemytitle.com/style/Wiki.
  • PR also includes other minor stylistic tweaks.

📝 Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

@netlify

netlifyBot commented Aug 12, 2022

Copy link
Copy Markdown

Deploy Preview for nuxt3-docs ready!

NameLink
🔨 Latest commit07f39c7
🔍 Latest deploy loghttps://app.netlify.com/sites/nuxt3-docs/deploys/62f7522b17f2ec00080dace0
😎 Deploy Previewhttps://deploy-preview-6578--nuxt3-docs.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 settings.

@danielroe

Copy link
Copy Markdown
Member

Love it! Consistency is important. Though my own personal preference is not to use title case but only capitalise first word - wdyt @pi0@atinux@antfu?

@pi0

pi0 commented Aug 12, 2022

Copy link
Copy Markdown
Member

I personally (Usually) capitalize titles to emphasize on keywords but not always but totally fine to keep the first start case as the convention.

  • ✔️ Faster Rendering
  • ❌ Pass Cookies From Server-side

@antfu

Copy link
Copy Markdown
Member

I don't have a strong opinion either. But This PR looks good to me as I suppose the title case is consistent and easy to follow.

@atinux

Copy link
Copy Markdown
Member

It looks good to me to have this consistency for headings 😊

Comment threaddocs/content/2.guide/6.going-further/3.modules.md
@pi0

pi0 commented Aug 12, 2022

Copy link
Copy Markdown
Member

What if we make an exception for non-keywords such as "to", "for", "with", etc to be lower cases?

@antfu

Copy link
Copy Markdown
Member

What if we make an exception for non-keywords such as "to", "for", "with", etc to be lower cases?

From my understanding, conjunctions should be lowercase already in the title.

pi0
pi0 approved these changes Aug 13, 2022
Comment threaddocs/content/2.guide/6.going-further/7.testing.md Outdated
@pi0
pi0 merged commit 92a04cc into nuxt:mainAug 13, 2022
@pi0

pi0 commented Aug 13, 2022

Copy link
Copy Markdown
Member

Thanks, @DamianGlowala <3 I've done a check and all titles seem now valid with APA Style (using this tool. It would be nice if we could make this process automated to avoid inconsistencies in the future (tracker: nuxt/nuxt#14566)

@pi0pi0 mentioned this pull request Aug 26, 2022
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@DamianGlowala@danielroe@pi0@antfu@atinux