search

SuperEvilMegacorp / vainglory-assets

Community provided art, schemas, and other assets that make using the Vainglory API easier
https://developer.vainglorygame.com
MIT License
54 stars 40 forks source link

Feature: Multiple language documentation #299

Open svperfecta opened 6 years ago

svperfecta commented 6 years ago

Expected Behaviour

We'd like all documentation to have the ability to be translated.

Current Behaviour

We support english only!

Possible Solution

Let's use the Gitbook format. This allows both online editing via www.gitbook.com and editing via the Githbook Editor. We still need to workout some sort of disclaimer on all internationalized documentation that they are community maintained and as up to date as possible. We still need to theme this, and put a deploy script on it in our CI.

Steps to Reproduce (for bugs)

  1. N/A

Context

We want to be open an accepting of anyone who wants to help!

Skillz4Killz commented 6 years ago

Idea For Disclaimer: Add a banner that is fixed at the top in the CSS theme to any page that is not English with the disclaimer saying something in the translated language

"NOTE: All documentation are maintained by the community and as up to date as possible. The latest and most up to date documentation are in English. Contact us at (insert discord link) for any help.

Edit: Gene i edited your post a bit to fix the broken link from www.gitbook.cm -> www.gitbook.com

Skillz4Killz commented 6 years ago

One of the biggest headaches my team had at translating the docs was how it kept changing. Especially for non-coders/GitHub users its hard for them to figure out what changed and when it changes. So they translate something and then it changes. If there was some way to have it so that when something was changed in the English section some alert or some sign to every other language would be amazing. But I have no idea how this could be possible but if it was this would be amazing.