Comments 34
sample.turnapi.com/docs/1.0/references-search-api
Для основных форматов (XML, JSON, к примеру) было бы здорово сделать подсветку синтаксиса и форматирование, а то как-то сложно разобраться в такой портянке.
Для основных форматов (XML, JSON, к примеру) было бы здорово сделать подсветку синтаксиса и форматирование, а то как-то сложно разобраться в такой портянке.
спасибо, поправили
я конечно не занудствую, но русскоязычные разработчики, представляющие продукт на русскоязчном ресурсе и нет русского языка…
Именно по этой причине у нас тоже были сомнения писать ли о проекте на хабре, но потом решили, что мы не единственные отечественный разработчики, кто ориентируется в первую очередь на запад. Ну и опять же, найдутся желающие пользоваться сервисом у нас, с радостью переведем на русский язык.
А кому он нужен для технической документации? Правильно, что не тратят время на рюшки.
В условиях ограниченных ресурсов (в которых находиться почти каждый стартап), тратить силы нужно только на самое важное и необходимое.
Русскоязычные разработчики, представляющие продукт в котором нет русского языка видимо верят в свой проект и понимают, какая у них целевая аудитория. Все правильно сделали, имхо.
А можно поподробней, в чем состоит git и svn интеграция?
Сейчас можно хранить всю документацию в git и синхронизировать с turnapi, то есть из репозитория происходит только чтение. В дальнейшем, появится возможность редактировать документы на сайте и подливать изменения в git. С svn тоже самое.
Уже обрадовался: как раз скоро выкладывать API. А без русского, к сожалению, не подходит :(
Английский, по сути, только язык интерфейса, Вы можете вести документацию на русском, никаких проблем с этим у Вас возникнуть не должно.
Я вообще не понял как работает интеграция с гитом:
Во-первых ваша система видимо ожидает какой-то структуры директорий и файлов, какая она?
Во-вторых как реализован доступ? Всегда анонимно по http? А если я не хочу всему миру свой код показывать?
В-третьих из какой ветки берутся файлы? Это настраивается?
Кроме того в чём разница между View Mode User и Preview?
Ещё, нарисуйте какой-нибудь тьюториал по пользованию редактором деревьев или добавть функционал создания поддерева в виде кнопки. DND в вебе _крайне_ неочевидная вещь.
Во-первых ваша система видимо ожидает какой-то структуры директорий и файлов, какая она?
Во-вторых как реализован доступ? Всегда анонимно по http? А если я не хочу всему миру свой код показывать?
В-третьих из какой ветки берутся файлы? Это настраивается?
Кроме того в чём разница между View Mode User и Preview?
Ещё, нарисуйте какой-нибудь тьюториал по пользованию редактором деревьев или добавть функционал создания поддерева в виде кнопки. DND в вебе _крайне_ неочевидная вещь.
вот подробнее о интеграции c git turnapi.com/blog/?p=9
В User mod Вы видите запаблишеные доки, а в Preview mod результат редактирования, т.е последнюю ревизию.
Мы четвертый день в бете, постараемся активнее описывать спорные вопросы в блоге. =)
В User mod Вы видите запаблишеные доки, а в Preview mod результат редактирования, т.е последнюю ревизию.
Мы четвертый день в бете, постараемся активнее описывать спорные вопросы в блоге. =)
Отлчное начинание!
Скажите, а кто у вас обычно писал документацию — технические писатели или программисты? И какие средствами вы пользовались до этого, что в итоге вас привело к такой идее?
Скажите, а кто у вас обычно писал документацию — технические писатели или программисты? И какие средствами вы пользовались до этого, что в итоге вас привело к такой идее?
Почему выбрали для реализации проекта Yii и какие были сложности?
Бесплатная версия только на время беты или потом тоже останется?
Интересный проект.
Напишите отличия от readthedocs.org, пожалуйста.
Напишите отличия от readthedocs.org, пожалуйста.
Неправильно отображается версия документа (иконки версии накладываются друг на друга)
Спасибо за замечание. Обязательно посмотрим в чем дело. Возможно проблема в шрифтах.
Теперь номера документов отображаются корректно, но сейчас неправильно отображается блок в котором написана версия(мне так кажется иначе сложно определить какую версию ты сейчас просматриваешь)
1.0
2.0
version current — текущая версия, но она не изменяется при выборе этой версии.
Так же постоянно перескакивает с одной версии документа на другую при выборе какого то определённого раздела.
Пишу сюда, так как до сих пор не могу совладать с вашим satisfaction)
1.0
2.0
version current — текущая версия, но она не изменяется при выборе этой версии.
Так же постоянно перескакивает с одной версии документа на другую при выборе какого то определённого раздела.
Пишу сюда, так как до сих пор не могу совладать с вашим satisfaction)
Sign up to leave a comment.
TurnAPI — пиши документацию легко