Coder Social home page Coder Social logo

Comments (13)

trekhleb avatar trekhleb commented on May 5, 2024 6

@vadimvildanov, @maksugr спасибо за интерес и за предложения по переводам!

Касательно переводов README файлов, думаю тут подход прозрачный. При добавлении нового языка нужно создать новый README.xx-XX.md файл и положить его рядом с оригинальным README.md. Если переведены так же README файлы конкретного алгоритма или структуры данных, то из корневого README.xx-XX.md файла ссылки могут вести прямиком на соответствующие README.xx-XX.md в подпапках.

Что касается перевода комментариев, думаю, что дублировать сами файлы с алгоритмами не лучший вариант. Возникает многократное дублирование одного и того же кода, его необходимо поддерживать в 2-х, 3-х, 4-х местах (в зависимости от количества языков). Дублирование возникает так же в тестах.

Единственное решение, которое я вижу - это создавать детальные и самодостаточные локализованные README (в данном случае README.ru-RU.md), такие, что необходимость в дополнительном чтении комментариев в коде отпадет сама по себе.

Самодостаточность README может быть достигнута разными путями:

  • в каждом локализованном README можно создать подраздел "Как это работает" или "Объяснение алгоритма" с подробным объяснением кода,
  • если этого недостаточно, можно написать псевдокод с локализованными комментариями,
  • если псевдокода недостаточно, можно при необходимости вставить сам исходный код в README и уже там написать локализованные комментарии.

Основная цель пунктов выше - локализации не должны влиять на исходный код.

from javascript-algorithms.

vadimvildanov avatar vadimvildanov commented on May 5, 2024 3

@joeberetta у меня в данный момент совершенно не хватает времени переводить, поэтому при желании можешь форкнуть мои изменения и продолжать делать.

from javascript-algorithms.

alexstulov avatar alexstulov commented on May 5, 2024 3

Сейчас есть ссылки на все переводы только с главной страницы. Что если в каждом README.md добавить аналогичные ссылки? Тогда пре переходе по ссылке в коде на английскую доку пользователь может следующим кликом перейти в доку на требуемом языке.

from javascript-algorithms.

maksugr avatar maksugr commented on May 5, 2024 2

@vadimvildanov из предложений только подключиться и помочь) например, вижу, что идет работа над алгоритмами, мог бы взять на себя структуры данных)

from javascript-algorithms.

maksugr avatar maksugr commented on May 5, 2024 2

Но вопрос о переводе комментариев - актуальный, так как это важная часть объяснения.

from javascript-algorithms.

maksugr avatar maksugr commented on May 5, 2024 1

@vadimvildanov

  1. index.js -> index.ru-RU.js не уверен, что лучшее решение. люди будут читать этот файл, но исполняться будет оригинальный => если "играться" нужно править оригинальный, что неудобно. нужно еще подумать.
  2. и еще, что нибудь надо от меня, чтобы переводить?
    не очень понял о чем ты) я пока предложил, что готов взять структуры данных и переводить .md файлы для них) ты можешь продолжать следовать своей логике и переводить все .md, кроме структур) а потом, если кто-то закончит свою часть раньше, синхронизируемся) буду коммитить в твой форк)
  3. на счет переводов комментариев в коде (и другого помимо .md) предлагаю подумать и решить позже в этом треде, пока есть над чем работать) плюс хотелось бы услышать мнение @trekhleb

from javascript-algorithms.

trekhleb avatar trekhleb commented on May 5, 2024

@vadimvildanov
Вадим, имя файла должно быть README.ru-RU.md, перевод желательно сделать "по максимуму" насколько это возможно: Insertion Sort → Сортировка Вставкой, AVL Tree → AVL дерево (?) и т.п. Спасибо за инициативу!

from javascript-algorithms.

vadimvildanov avatar vadimvildanov commented on May 5, 2024

Ок, спасибо за оперативный ответ!

from javascript-algorithms.

maksugr avatar maksugr commented on May 5, 2024

Речь только о переводе README?
Вижу, что на китайский (?) переведен только README, а все ссылки ведут на английскую версию. Видится, что толку в этом мало и при переводе нужно переводить все .md файлы и комментарии к коду.
Как при таком подходе предлагается организовать файловую структуру?

from javascript-algorithms.

vadimvildanov avatar vadimvildanov commented on May 5, 2024

В данный момент сырой перевод, который я делаю своими силами таков: https://github.com/vadimvildanov/javascript-algorithms

Пока что предполагается к каждому readme.md класть readme.ru-RU.md, по поводу комментариев в коде пока сказать ничего не могу.

Ссылки буду подменять, когда буду перечитывать и править текст.

Если есть какие-либо предложения, то я весь во внимании.

@maksugr

from javascript-algorithms.

vadimvildanov avatar vadimvildanov commented on May 5, 2024

По поводу перевода комментариев, также дублировать index.js -> index.ru-RU.js ?

@maksugr

и еще, что нибудь надо от меня, чтобы переводить?

from javascript-algorithms.

joeberetta avatar joeberetta commented on May 5, 2024

Всем привет, тоже заинтересовался в этой теме, и хотелось бы поучаствовать в локализации. Может нужна какая помощь?

from javascript-algorithms.

trekhleb avatar trekhleb commented on May 5, 2024

@kinospro да, такой вариант тоже возможен.

from javascript-algorithms.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.