[spoiler]
И в документации и в курсах добавлен механизм табов. Тексты ещё не везде адаптированы под табы, работа ведётся.
Цель внедрения табов: максимально избавится от прокрутки экрана.
С табами страница доки в тёмной теме выглядит так:
С табами страница курса выглядит так:
С курсами всё немного сложнее чем с докой. ТАм Табы только делают работу удобнее, но от прокрутки не избавляют в некоторых случаях.
Хотели так же облегчить пользование инструментом "Прочитано!". Попытались сделать установку этого знака для глав в автоматическом режиме. Но это оказалось накладно для сервера. Настолько накладно, что у части пользователей не подгружались все css файлы шаблона и "летела" вёрстка. В Открытых линиях мы получили много нареканий на это. Автоматику пришлось отключить.
Другое новшество, правда не до конца ещё реализованное - это система баллов. Каждый урок теперь имеет своё число баллов, вывод их отображется в каждом уроке:
Теперь непосредственно о новинках документации
Документация API D7
Сделано:
- Компонент
- отрисовки пользовательских полей в модуле iblock
- отрисовки пользовательских полей в модуле main
Курс Контент-менеджер
Сделано:
Курс Администратор Бизнес
Сделано:
Курс Разработчик Bitrix Framework
Сделано:
Файлы CHM будут выложены в течение дня.
Удачи всем нам!
p.s. Спасибо, что запретили использовать `ctrl+f` на странице, а то вдруг документацию будут использовать по назначению...
Как ни пробовал, не получилось у меня так загнать меню что нельзя открыть, просто не получается его так сдвинуть как у вас.
А в других браузерах не пробовали открыть?
Сейчас всё хорошо) Спасибо)
у меня тоже порой при открытии так уезжает и не сразу, если вспомнишь про задвигание, думаешь, что не разворачивается
Браузер chrome преимущественно
Если из гугла переходишь, то попадаешь на страницу для печати с гет-параметром
И тогда боковая панель не работает и если нажать на раскрытие, она запомнит что открылась на 0-5 пикселей и потом будет только краешек её.
С одной стороны получилось хайпануть на темной теме и стало субьективно удобнее пользоваться документацией. Не скажу за тему, но табы в некоторых случаях дали обратный эффект: если их незаметить (а очень часто я на себе ловлю такой 'глюк') то статья становится совершенно нечитаемой. Мне например далось больших трудов отыскать как ui.forms стилизовать select (он зарыт в таб dropdown в непримечательном месте).
С другой же стороны для новых пользователей это сильный такой пинок: нужно разобраться в том, как у вас устроена документация и уже потом начать ее читать (хотя все должно быть просто - открыл и 'поехал'). Темная тема конечно есть, но простите - она ужасна. Посмотрите на цвета sublime text 3 из коробки, посмотрите на темные темы Atom, да даже на темную тему windows 10 посмотрите - они намного приятнее.
С моей колокольни у документации есть обьективные недостатки (внимание на которые нужно обратить в первую очередь):
1) Системность изложения.
Сейчас документация представляет из себя смесь между "how-to", "перечнем методов", "структурой таблиц" и отвлеченного рассуждения.
Я считаю, что необходимо ее разделить: все how-to (например как выгружать большие обьемы данных, почему не нужно хранить адрес портала и если хранить то как с ним работать и т.п.) отделить от базовых принципов (как работают встройки, структуры запроса/ответа для обычного и batch вызова), рассказать про отличия веб-хука и oauth.
2) Перестать приводить примеры на JS
Это кричащий заголовок по сути расшифровывается так: примера на js недостаточно для понимания работы. Ваше api не самое простое, а разработчику (особенно начинающему) на python/php/и т.п. оно вообще представляется сумбурным (особенно когда речь доходит до авторизации и параметров).
Введите уже наконец нормальное пояснение: вот пример на JS c нашей библиотекой, а вот на 'голом' php+curl, а вот тут просто curl.
Да, это тоже работа, но проделав ее не придется больше отвечать на эти вопросы: а как передать, а вот я делаю "как в доке", но не получается и т.п.
Вдохновиться можно вот тут:
3) Напишите уже как работать с чертовыми файлами.
Эта тема уже заезжена и избита, а в вашей документации она представляет собой 10 строчек, который хрен найдешь.
Напишите с примером в разные методы как их загружать, как их удалять и как загружать большие файлы (chunk и т.п.)