search

Cog-Creators / Red-DiscordBot

A multi-function Discord bot
https://docs.discord.red
GNU General Public License v3.0
4.63k stars 2.28k forks source link

Docs: Improved introduction to i18n for Cog authors and Translators #6351

Open jamesread opened 3 months ago

jamesread commented 3 months ago

Description of the changes

This is a simple doc PR on the i18n framework page, that hopefully makes translations and internationalization a little more accessible for new Cog authors, and translators.

I confess that I don't actually use the Red project, but simply was helping a friend get started with translations for the first time. I found the docs a bit too brief about how to get started, and think that if there was a bit more explanation about the different types of files, and the ignoring of .mo files, using -'s instead of _'s, and similar, it probably would have been an easier experience.

First time contributor - I've read CONTRIBUTING.md, but my apologies in advance if I've missed a step, as I'm not familiar with this project!

Have the changes in this PR been tested?

Yes (docs only)

jamesread commented 3 months ago

Now I see the broken docs tests :-) That's what happens when I write too much asciidoc and markdown. Will put a new commit to fix in a second.

jamesread commented 3 months ago

c685f9e pushed just now - it just fixes the double-backtick formatting needed for rst, rather than the single-backtick that I'm used to from asciidoc/markdown! I thought this looked somewhat better than the :code: syntax for just highlighting file extensions etc?

I don't intend to make any further commits at the moment -- so this is for your review/comments, etc. :-)

jamesread commented 3 months ago

@Flame442 , thanks for taking the time to review. I've read through your suggestions and comments, and everything generally sounds fine. Because I've not used the project directly, I'm not familiar with some of the style/conventions, thanks for taking the time to point those out. Happy to revise this PR.

I'll probably just accept all the suggestions batched up into a single commit, and use another commit where a bit more context is called for / more examples are needed, if that approach is OK for you?

Just about to head to bed now, I'll do this when I next get some time available over the next few days.

Flame442 commented 3 months ago

That sounds fine to me. Let me know when everything is resolved.