Linguo tutorial by @0xMentalist

products/linguo/README.md

@@ -1,11 +1,39 @@
 ---
-description: A Decentralized Translation Platform
+description: >-
+  This is a step-by-step guide that explains how to use Linguo. Please go
+  through it to acquaint yourself with the platform!
 ---
 
-# Linguo
+# How to use Linguo
 
-🤖[Linguo App](https://linguo.kleros.io) 🤖\
-\
-**Linguo** is an easy-to-use decentralized translation Dapp allowing both translators and translation requesters to interact in a completely trustless manner. It came to light due to our own internal needs for multi-language translation of Kleros content. As it turns out, you can get quality services at a low price when calling on the decentralized free market.
+Before you begin you need to,
 
-![](<../../.gitbook/assets/image (3).png>)
+* [ ] Set up a decentralised wallet.
+
+{% hint style="info" %}
+You can use this tutorial from [Binance Academy](https://academy.binance.com/en/articles/how-to-use-metamask) to help you do this.&#x20;
+{% endhint %}
+
+* [ ] Connect to the Gnosis (xDai) chain.
+
+{% hint style="info" %}
+Here is a helpful tutorial from [Gnosis](https://developers.gnosischain.com/for-users/wallets/metamask/metamask-setup) to help.
+{% endhint %}
+
+* [ ] Fund the wallet
+
+{% hint style="info" %}
+If you don't have Ethereum get some! [Here's how.](https://ethereum.org/en/get-eth/)
+
+If you already have Ethereum you can follow the [tutorial](https://jaredstauffer.medium.com/how-to-get-xdai-how-to-convert-dai-to-xdai-eth-dai-xdai-30a60e4b6641) here.
+{% endhint %}
+
+Now you can head over to the [Linguo page and get started. ](https://linguo.kleros.io/home)
+
+Linguo currently runs the Gnosis (xDai) chain since gas fees are lower, so make sure you’ve connected to the Gnosis (xDai) chain before continuing with the rest of the tutorial.
+
+Once you have everything set up, navigate to the home page and connect your wallet. You now have 3 options;
+
+* [Request a translation.](tutorials/requesting-translations.md)
+* [Work as a translator](tutorials/working-as-a-translator.md).
+* [Review submitted translations.](tutorials/reviewing-translations.md)

products/linguo/SUMMARY.md

@@ -0,0 +1,14 @@
+# Table of contents
+
+* [How to use Linguo](README.md)
+
+## Tutorials
+
+* [Requesting translations](tutorials/requesting-translations.md)
+* [Working as a translator](tutorials/working-as-a-translator.md)
+* [Reviewing translations](tutorials/reviewing-translations.md)
+
+***
+
+* [FAQ.](faq..md)
+* [High-level Overview](high-level-overview.md)

products/linguo/faq..md

@@ -0,0 +1,164 @@
+---
+description: Here you can find answers to frequently asked questions.
+---
+
+# FAQ.
+
+<details>
+
+<summary>How does Linguo evaluate translator's skills?</summary>
+
+Short answer: it does not. Translator skills are self-declared.
+
+</details>
+
+<details>
+
+<summary>If there is no evaluation process, how can I be sure the translator is qualified enough for the job?</summary>
+
+\
+Linguo uses crypto-economic incentives to regulate the behaviour of users. Translators are required to provide a deposit when they are assigned to a task.
+
+After the translated text is submitted, there is a review period. During this time, anyone (including yourself) can look for potential flaws in the translation and raise a challenge.
+
+If a translation is challenged, a case is created in a specialized Kleros court which decides whether or not the translation fulfils the requirements. If the challenger wins the case, the translator loses the initial deposit, which is then sent to the challenger as a reward for her or his work.
+
+This way we incentivize translators to only accept tasks they think they are qualified enough to work on, otherwise they will suffer financial losses.
+
+</details>
+
+<details>
+
+<summary>How are translator skills defined in Linguo?</summary>
+
+Linguo considers language skills as defined by the [Common European Framework of Reference (CEFR).](https://www.coe.int/en/web/common-european-framework-reference-languages/level-descriptions)
+
+</details>
+
+<details>
+
+<summary>I am not sure how I rank on the CEFR scale. How can I find out?</summary>
+
+You can test your skills by using this [self-assessment grid.](https://rm.coe.int/CoERMPublicCommonSearchServices/DisplayDCTMContent?documentId=090000168045bb52)
+
+</details>
+
+<details>
+
+<summary>What are the Linguo translation tiers?</summary>
+
+Linguo translation tasks can be defined in 3 different quality tiers:
+
+Cost Effective: A basic translation. The conveyed meaning must be similar, but nuances might be lost. Occasional typos and translation errors are acceptable. Standard: The standard level of a translation. The meaning must be almost identical. Occasional typos are acceptable. Professional: Professional translation. The meaning and spirit of the translation must remain identical and the translator must reflect the style and nuances of the original text. Translators are expected to have their text reviewed before submission.\
+
+
+</details>
+
+<details>
+
+<summary>How do my skill levels affect the number of tasks I will be able to work on as a translator?</summary>
+
+Translation tasks are available according to the required translation tier as specified by requesters:
+
+Cost Effective: translators with B2 level and above.Standard: translators with C1 level and above.Professional: only translators with C2 level.
+
+Notice that if your level is lower than B2, you will not be eligible for any translation tasks in Linguo.
+
+</details>
+
+<details>
+
+<summary>Why does Linguo support only translations to and from English?</summary>
+
+Currently, finding specialized jurors to evaluate a translation between an arbitrary pair of languages has been challenging (e.g.: Korean ↔ Russian).
+
+We use English as the “pivot” language, so there can be enough jurors.
+
+</details>
+
+<details>
+
+<summary>I need a translation between two languages other than English. What do I do then?</summary>
+
+Currently, finding specialized jurors to evaluate a translation between an arbitrary pair of languages has been challenging (e.g.: Korean ↔ Russian).
+
+We use English as the “pivot” language, so there can be enough jurors. At this point, there is one way to do this. Let’s say you want a translation Korean → Russian:
+
+1. You should first create a translation task for Korean → English.
+2. Then, after this intermediate translation is delivered, you can create another one for English → Russian.
+
+</details>
+
+<details>
+
+<summary>Why do I need to set a minimum and a maximum price when requesting a translation?</summary>
+
+From the moment you create the translation task to the moment some translator assigns to it, the price will increase linearly. The higher the payout, the more interesting it will be for translators to work on your translation task.
+
+This will help you discover the right prices for your tasks.
+
+If you would like to avoid this mechanism, you can set the same value for both minium and maximum price.
+
+</details>
+
+<details>
+
+<summary>What happens to my deposit if a translator picks up the task before it reaches the maximum price?</summary>
+
+From the moment you create the translation task to the moment some translator assigns to it, the price will increase linearly. The higher the payout, the more interesting it will be for translators to work on your translation task.
+
+This will help you discover the right prices for your tasks.
+
+If you would like to avoid this mechanism, you can set the same value for both minimum and maximum price. When a translator is assigned to a task, your remaining deposit — the maximum price minus the current price — is immediately sent back to your wallet.
+
+This is done automatically, there is no need for user input.
+
+</details>
+
+<details>
+
+<summary>Is there a limit on the number of translation tasks I can request on Linguo?</summary>
+
+No. You can request as many tasks as you want, even at the same time.
+
+</details>
+
+<details>
+
+<summary>Is there a limit on the size (text length) of translation tasks I can request on Linguo?</summary>
+
+There is no hard limit.
+
+If a task is too long, reviewers will probably try to optimize their work and evaluate only certain segments of the whole text. This might lead to reviewers overlooking certain mistakes in the translation.
+
+It is safe to expect that reviewers will be efficient enough in finding errors (as they are financially incentivized to), however, if the translation is critical, you should also make sure to do a double check and review the translation yourself.
+
+We advise you to break longer translations into multiple parts whose individual size is around 4,000 words.
+
+Notice that currently there is no guarantee that all individual tasks will be assigned to the same translator, as anyone with the required skills could do this at any time.
+
+</details>
+
+<details>
+
+<summary>Should I trust the word count for a given translation task displayed on the Linguo interface?</summary>
+
+The short answer is: no! Always double-check it yourself.
+
+Linguo works with several languages and a myriad of file formats. There is currently no fail-proof way to determine the word count for a translation task.
+
+While we do have some heuristics in place to get the approximate word count for text-based file formats, such as TXT, PDF or JSON, its input is ultimately controlled by the translation requester.
+
+</details>
+
+<details>
+
+<summary>What are the different fees?</summary>
+
+Challenger Fee: Deposit paid by a challenger when raising a dispute.
+
+Translator Fee: Deposit paid by translator while accepting a translation request.
+
+Arbitration Fee: Paid out to jurors for ruling on a dispute.
+
+</details>

products/linguo/high-level-overview.md

@@ -0,0 +1,7 @@
+---
+description: Here is a flow chart that gives you an overview of how Linguo works.
+---
+
+# High-level Overview
+
+![Follow the legend.](<../.gitbook/assets/tree (1).jpg>)

products/linguo/tutorials/requesting-translations.md

@@ -0,0 +1,75 @@
+---
+description: Here is a step-by-step guide on how to use Linguo to request translations.
+---
+
+# Requesting translations
+
+1\. Click on the My Translations option to see a list of ongoing translation requests that you have submitted.
+
+![Alternatively, you can click the request translations above to reach the same page.](../../.gitbook/assets/r1.jpg)
+
+2\. Click the new translation button to begin the submission.
+
+![Click on New Translation](../../.gitbook/assets/r2t2.jpg)
+
+3\. Fill out the form and click next to continue with the next step.
+
+{% hint style="success" %}
+* Choose your source language (the language you want to translate) and your target language (the language you are translating to). 
+* Choose the expected quality of the translation (make sure you choose carefully as this matches your request to a translator with the appropriate level of experience)
+{% endhint %}
+
+![Fill out the form depending on your requirement.](../../.gitbook/assets/r3.jpg)
+
+4\. Now input all the details of your request and click Request the translation. 
+
+{% hint style="success" %}
+Ensure this form is filled out accurately to avoid disputes.
+{% endhint %}
+
+{% hint style="success" %}
+The pricing section is where it gets more interesting. Here, you will see three parameters: Deadline, MinPrice and MaxPrice.
+
+The price rises linearly from the start date to the finish date offering an auction-like scenario for translators to decide their own personal acceptable price point for each piece of content.
+
+For example, you can price your translation to be picked up quickly by opening with a high minimum price. Conversely, a broad spread between the minimum and maximum price set over a longer deadline (30 days, for example) gives a steadier price increase over time starting from a more reasonable entry point.
+
+If you just want a fixed price translation with no price discovery, set both the Min and Max price to the same value. The pricing system. High initial prices will likely get your translation completed quicker.
+
+
+{% endhint %}
+
+![Almost done.](../../.gitbook/assets/r4.jpg)
+
+5\. You will now be prompted with a transaction in your wallet. Please double-check the details and click confirm.
+
+![This will create a new task as per your specifications.](../../.gitbook/assets/r5.jpg)
+
+6\. Your request is now active! A translator should pick it up shortly.
+
+![Your request will appear on the list!](../../.gitbook/assets/r6.jpg)
+
+{% hint style="info" %}
+**In case your request isn’t picked up on time, you can collect your deposit by clicking ‘Reimburse Me’.**
+
+****![](../../.gitbook/assets/r6.b.jpg)****
+{% endhint %}
+
+7\. You will be notified every time an update happens on your request. You can see them by clicking the notifications icon on the upper right-hand side.
+
+![You can see updates every step of the way. ](../../.gitbook/assets/r7.png)
+
+8\. Once the translator submits the translation, it will be under review for 7 days. During this time you or any jurors can review it and create a dispute if the final result isn’t satisfactory or doesn’t meet your specified requirements!
+
+{% hint style="info" %}
+If you want to dispute the translation you can do it as follows.
+
+* To submit a challenge navigate to the request page, gather your evidence in a file and upload it by clicking the Evidence for Challenge button and confirm the transaction in your wallet.
+
+![](<../../.gitbook/assets/Screenshot 2022-07-22 at 11.29.46 AM.png>)\
+
+
+* Once you’ve submitted the evidence and made the challenger deposit the case will be sent to the respective courts to be evaluated by the jurors.
+
+![](../../.gitbook/assets/r9v2.png)
+{% endhint %}

products/linguo/tutorials/reviewing-translations.md

@@ -0,0 +1,39 @@
+---
+description: >-
+  You can also earn by reviewing translations done on the platform. Here is how
+  that works!
+---
+
+# Reviewing translations
+
+1. Click the Review Translations option to see available translations to be reviewed.
+
+![](<../../.gitbook/assets/v1 (1).jpg>)
+
+2\. Create a profile and fill in your language proficiency details.
+
+{% hint style="info" %}
+Please make sure you do the self-assessment accurately as this would ensure you get matched to jobs that you are most suited for.
+{% endhint %}
+
+![Enter all languages you are comfortable with and hit save.](../../.gitbook/assets/t2.jpg)
+
+3\. Now you will see all open translations for review.
+
+![Select a file that matches your skillset.](<../../.gitbook/assets/Screenshot 2022-07-22 at 11.05.36 AM.png>)
+
+4\. Once you have chosen the file you’d like to review, gather your evidence and challenge the submission.
+
+![](<../../.gitbook/assets/Click this to submit a new request..jpg>)
+
+5\. Once you’ve submitted the evidence and made the challenger deposit the case will be sent to the respective courts to be evaluated by the jurors.&#x20;
+
+{% hint style="info" %}
+**What happens now?**
+
+If your challenge is rejected you lose the challenger deposit.
+
+If your challenge is approved;
+
+your payout = translator deposit + (challenger deposit - arbitration fees)
+{% endhint %}