Skip to content

Conversation

@rootulp
Copy link
Contributor

@rootulp rootulp commented Jul 18, 2022

I preserved capitalization for H1s where the noun was the sidebar name (ex. Full Storage Node, Bridge Node, etc.) and sentence cased all other titles (H2+).

Resolves #161

I preserved capitalization for H1s where the noun was the sidebar name
(ex. `Full Storage Node`, `Bridge Node`, etc.) and sentence cased all
other titles (H2+).

Resolves celestiaorg#161
@rootulp rootulp marked this pull request as ready for review July 18, 2022 17:48
@YazzyYaz YazzyYaz self-requested a review July 20, 2022 09:50
@YazzyYaz
Copy link
Contributor

Hey @rootulp I'll get back to this next week, my general thinking though is that title case are fine in sub-headings as they're still titles.

What is the thinking around lower-casing subheadings below H1? Is that part of a style guide you can link me to?

@rootulp
Copy link
Contributor Author

rootulp commented Jul 21, 2022

No rush on reviewing this, next week is fine. We should align on whether we want #161

What is the thinking around lower-casing subheadings below H1? Is that part of a style guide you can link me to?

It's a style thing. https://design-system.service.gov.uk/styles/typography/#headings states:

Write all headings in sentence case.

but I'm sure we can find style guides that state the opposite. This PR was motivated by me noticing that the docs contain a lot of capitalization (in titles and paragraphs) which led to my confusion on which words were proper nouns. We probably don't need sentence-cased titles if we do #160 along with downcasing words in paragraphs that aren't proper nouns.

@YazzyYaz
Copy link
Contributor

I can go either way, although not too sure on the new styling.

@dabit3 any thoughts?

@dabit3
Copy link
Contributor

dabit3 commented Jul 26, 2022

Looks good to me, only question is "what do we consider proper nouns"

I.e. are Light / Bridge / Full / etc... nodes a proper noun? Or is it just at type of Celestia node?

@rootulp
Copy link
Contributor Author

rootulp commented Jul 26, 2022

I.e. are Light / Bridge / Full / etc... nodes a proper noun? Or is it just at type of Celestia node?

I think just a type of node. For example "light client" and "light node" are not capitalized in:

@dabit3
Copy link
Contributor

dabit3 commented Jul 26, 2022

@rootulp makes sense, looks great to me!

@dabit3 dabit3 merged commit 542d0ca into celestiaorg:main Jul 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Sentence-case all titles for consistency

4 participants