Ensure consistent wording

[lukasbestle]

E.g. "Panel" always uppercase.

[distantnative]

And I just changed it in a few places to lowercase 🙈 Do we have a style guide for these and other terms?

[lukasbestle]

I don't think so, but maybe we should make one.

I'd suggest to use uppercase Panel as it's the Panel, not some kind of panel. Which other fixed terms do we have besides the Panel?

[distantnative]

KirbyTag/s (which I have seen today in all possible forms of capitalization) Kirbytext

[lukasbestle]

Maybe we should uppercase everything that's in the glossary. So for example also Blueprint or Field Method. Then it's clear that those terms are fixed and mean exactly that one thing.

On the other hand, that would look a bit strange. So a compromise would be the following:

• Everything that is a "trademark" of some sorts is written like intended by the author:

  GitHub, SmartyPants, Markdown, Vue, Whoops, MySQL, SQLite

• Our own names are written like this:

  Kirby, Panel, KirbyTag, KirbyTags, KirbyText, Starterkit, Plainkit

• Acronyms are full-caps:

  API, SQL

• Everything that is not a trademark/name or acronym is lowercased (if not at the beginning of a sentence):

  template, snippet, blueprint, field method, ...

I think that's what I would prefer. What do you think @bastianallgeier?

[distantnative]

I like that. I'd add that we consistently use Vue not Vue.js.

[lukasbestle]

Hm, in the code we currently use camelCase for KirbyTag and KirbyTags. So we should probably use that on the site as well. Or change it in the code? I'm not sure.

[distantnative]

I don't mind either, but if it is KirbyTags it should also be KirbyText, right?

[distantnative]

Another one I found: Is it GitHub or Github for us?

[distantnative]

And... SQL or sql?

[distantnative]

Another one I found: Is it GitHub or Github for us?

I feel we should be consistent here. If GitHub gets camel-case, then SmartyPants gets too etc. My preference would be to get completely rid of camel case.

[lukasbestle]

Another one I found: Is it GitHub or Github for us?

GitHub, as it's a trademark. We should write those exactly like they are defined.

You are right: The author of SmartyPants also uses camelCase, so that's what we should do as well. But not because we will consistently use camelCase, but just because that's the "right" capitalization. For example Markdown is written without camelCase.

And... SQL or sql?

SQL, it follows the "it's an acronym" rule.

[texnixe]

• SQL, MySQL

[bastianallgeier]

I agree with everything said so far. I'm not particularly happy with camelCase myself, but I still think we should use KirbyTags and KirbyText in camelCase. Just because those two are very close and it feels more readable to me in camelCase.

Do we have any other pseudo-brands?

Kirby Panel KirbyTag KirbyTags KirbyText

I can't think of any at the moment.

[distantnative]

I'll update the PR with these.

[lukasbestle]

Alright, sounds good to me. I will write an internal style guide for Notion on Monday for the future. :)