manual: Dutch translation

[ghost]

Hi!

I'm a woman speaking Dutch as native language.
I'm interested in translating the surge XT manual to Dutch.

However I have no knowledge of html, tools, compiling documentation, websites, ...
So I only can use a text editor or a program like LibreOffice

Is there a way I can translate the text and provide the team with a LibreOffice document containing the translated text, so you can convert it to the right format to put online (like the English version)?
I will put in all pictures too and respect all paragraphs of the text, so you can exactly see where the text is located and it can be copy-pasted very easy for the person who will put it in the desired format.

Ps: please note I'm autistic and need VERY clear instructions on how to do this correctly (I mean the format to use for the translation. The translation itself is no problem as I have good English knowledge).
As a consequence of my autism, I don't like to go into chatboxes like Discord (real-time chat) so going to surge's Discord server is not an option for me.
So I prefer contacting on github here or if anybody wants to help me personally by email (to get me up-and-running) that's OK too.

Ps 2: I have a very strong dedication when I'm doing something. This means I want to keep updating my translation for updates.
Unfortunately I never worked with github and don't know how to do a PR, ... I'm actually a bit scared of doing something wrong.
If it's possible, I would like to give my translation here as an attachment so a contributor can submit it in the correct way.
Maybe if it's easy to do this on github (I never used github), I can try to do it myself.

So that's why I ask if somebody can 'guide' me here so I can contribute to this wonderfull project by translating the manual to Dutch.

Thank you
Lien

[mkruselj]

Hello and welcome!

To hit it right off, let me just tell you that you don't need to know HTML. Our manual is in Markdown format, which is really just raw text with a few additional rules for stuff like bold, italic, monospaced text, links, and so on. How it all ends up looking is already handled by our website back end.

Our website is actually in another repository, here, and you can see there's an issue for manual translators right there, which you should subscribe to - and maybe we could continue the discussion there, as that repository is for all things website related, and this particular repository to which you have posted is for Surge plugin itself.

But in short: the manual itself is found here. We would do a copy of this file and name it Surge-XT-NL.md (let me do that), and from thereon you can go ahead and press the Edit button:

which opens a text editor and that enables you to start translating. Now, you can do this directly in here, and then put it all on a branch and start a pull request, it's easy when you do it like this and you cannot do anything wrong (just never select "Commit directly to master branch"! 🙂). On the bottom of this text edit page you will see:

Then you can simply repeat the edit procedure on your branch by adding commits (instead of opening a new branch and a new pull request for every new edit you make). But we can get to that point later. For the time being, I have created a copy of the file that kickstarts the Dutch translation, here.

See you on the other side!

[baconpaul]

Welcome @synthvst great instructions @mkruselj :)

[ghost]

I have put this "on hold" because I don't have enough experience with Surge XT.
So it's better to translate it when I fully know everything.

[ghost]

How would I know what added things are added to the manual, when the English version gets updated?
Can somebody explain me for the future?

[mkruselj]

This is done through pull requests. You can always see how our website is updated in the commit log, here.

[baconpaul]

Git shows diffs (changes) in the transaction log so you would use that to see what was changed, at the link above.