Spelling on about page

URL: https://gitworkshop.dev/about

ensure that user who have already cloned the repository dont get

->

ensure that users who have already cloned the repository don't get

Your not replacing GitHub, your still using it GitHub as a git server.

->

You're not replacing Github; you're still using GitHub as a git server.

it is trivial to switch git servers as they all operate the exact same protocol.

->

It is trivial to switch git servers, as they all operate with the exact same protocol.

Lots more. What do I need to submit a PR?

Reply to this note

Please Login to reply.

Discussion

Many sentences begin with lower case. This may be a style thing, and is often done for bullet points, but is not good for regular paragraphs.

it was a stylistic choice but if its annoying I don't mind changing it

The style is inconsistent. Some sentences begin with upper case. Some paragraphs end with a period. Dropping the traditional "capitalize first letter of every sentence" style is handy for tech documents which often begin sentences with identifiers which are confusing when capitalized (e.g. "git").

* I propose to keep starting sentences with lower case, but end all sentences with punctuation. (Even some paragraphs currently end with period.)

* Titles (headers) are capitalized.

* Some FAQ questions are capitalized, some not. I think they should be capitalized in traditional style. Rewording can avoid starting with an identifier (like "git"). The answers follow the (no initial capital) paragraph/sentence style above.

Is `src/routes/about/+page.svelte` the source for the about page? Or something generated?

Its the source.

Hmmm. What about sentences ending in an identifier? E.g.

ngit is more opinionated focusing on nip34+

Or we could go with "period as separator, not terminator". Current style is inconsistent.

We could mandate html "code" style for identifiers. I'll be inconsistent and do that only when then end a sentence for this pass.

OK. We will probably need a markdown file as a style guide so I don't forget the rules!

I added proposed rules as an HTML comment. I'm figuring out how to send the patch. Might have to be email.

Hope I did that right. It's been decades since I sent patches via email.

Did you use the `ngit send` command?

No. Just sent email. To your protonmail listed in your commits.

Thanks. I pushed it live. What a helpful contribution.

If you had a lightning address set up, I'd zap you.

It was. Was annoying to read, before.