I am new to codeberg and this documentation. I am not sure whether this is the right place to raise this discussion.
If it is not, please feel free to move it or point me to the correct place.
Is there a style guide of some sort for the documentation?
I just edited an article yesterday and consistently used the word Email all the time, in favour of eMail, email or e-mail.
I just (by chance) saw @ka2in in !215 using " and " instead of quotes (") and using the lower case email.
(No offence @ka2in, just a good example for something that could be added to a style guide of some sort. I am in favour of using " and " and email, too.)
It would be good to have a clear guide on how to use quotes and how to spell email. I am sure there are other things that can be documented as well, like whether to use rendering hints when using triple backticks shell or not .
I found https://docs.codeberg.org/improving-codeberg/docs-contributor-faq/ but it does not say anything about quotes or about how to write certain words. There is also !59 on a general markdown documentation but that would a bit different to a style guide.
Anyway I would favor such a document in which these and other cases are documented.
I would also favour a whole section "Documentation". The current docs-contributor-faq is somewhat huge and could be easily split into smaller documents (How to write an article, How to create a screenshot, etc.) (Maybe thats something for a different issue?)
Don't get me wrong, I do not want a new law, just a guide for new people like me who want to improve the documentation and want to do so in a way consistent with what others already did.
What do you think?
I am new to codeberg and this documentation. I am not sure whether this is the right place to raise this discussion.
If it is not, please feel free to move it or point me to the correct place.
Is there a style guide of some sort for the documentation?
I just edited an article yesterday and consistently used the word Email all the time, in favour of eMail, email or e-mail.
I just (by chance) saw @ka2in in !215 using “ and ” instead of quotes (") and using the lower case email.
(No offence @ka2in, just a good example for something that could be added to a style guide of some sort. I am in favour of using “ and ” and email, too.)
It would be good to have a clear guide on how to use quotes and how to spell email. I am sure there are other things that can be documented as well, like whether to use rendering hints when using triple backticks ` ` `shell or not ` ` `.
I found https://docs.codeberg.org/improving-codeberg/docs-contributor-faq/ but it does not say anything about quotes or about how to write certain words. There is also !59 on a general markdown documentation but that would a bit different to a style guide.
Anyway I would favor such a document in which these and other cases are documented.
I would also favour a whole section "Documentation". The current docs-contributor-faq is somewhat huge and could be easily split into smaller documents (How to write an article, How to create a screenshot, etc.) (Maybe thats something for a different issue?)
Don't get me wrong, I do not want a new law, just a guide for new people like me who want to improve the documentation and want to do so in a way consistent with what others already did.
What do you think?