beeware
Inconsistent title case in docs
What is the problem or limitation you are having?
Some page titles and subheadings in Toga's docs are in title case, and some only have their first word capitalized. For example, the below screenshot shows "API design" next to "Data Sources", and "Supported Platforms" next to "Toga APIs by platform".
Describe the solution you'd like
I think we should pick one approach and stick to it. Personally, I'd vote for title case, since... they're titles.
Describe alternatives you've considered
We could also commit to first-word capitalizing. The sentence/phrase-like tutorial titles (e.g. "You put a box inside another box...") might read more naturally that way.
Edit: Chosen approach
All titles should be first-word-only capitalized, and the tutorial's sentence-like titles should be replaced with "real" titles.
Additional context
No response
Agreed we should be consistent; and conforming to a specific style guide (AP? APA? Chicago?) would also make sense.
As for "phrase titles" - I'd probably lean towards editing to remove those. They might make a good subtitle, but they're not great titles, as they're often "in jokes" or highly contextual. That becomes even more important when translations are in the mix.
I agree with removing the "phrase titles", but I still think capitalizing only the first word is more readable and appropriate – these are topics, not entire works.
From a quick survey, Python's docs and Django's docs (which I'd call two of my gold standards for "documentation that has been edited by someone with good English skills) both use "Sentence case" for headings.
From a quick research, it looks like a couple of style guides make the same call - the APA style guide, the AU government style, and I think Chicago (there's a few references that suggest this, but I can't find a good canonical source) all make the specific distinction that you've made here - document titles are Title Case; headings within works are Sentence case.
So - unless there are objections, lets go with that.
If we want to pick a specific style guide to follow as a base set of rules, that would be even better... preferably one that is available online for free (but I doubt that's going to be possible).
Alright, can do. And I can try and give the tutorials more descriptive names.
I'm most familiar with Chicago — not to say very familiar, just more than with any others. (It happens to be what Magic: The Gathering uses.) But it is behind a paywall.
@manishbandari237-source Hi - we don't formally assign issues, so if you'd like to work on this, go right ahead!