Документация по фреймворку
Владимир Тупоршин-мл.
18 октября 2012
В ближайшее время мы планируем серьезно переработать документацию по фреймворку Вебасист. Очень хотелось бы узнать о вашем опыте работы с фреймворком и документацией, особенно об опыте разработки собственных приложений и создании сайтов.
Чего не хватает в документации больше всего? Туториалов? Видео-туториалов? Демо-приложений? Поиска по документации? Справочника по всем классам и методам? Было ли понятно с чего начинать? Проблемы при установке? Нужны ли примеры изменения шаблонов дизайна? Непонятно, как работает роутинг?
Пожалуйста, расскажите, что лично вы хотели бы видеть в документации. Принимаем любые пожелания!
7 комментариев
Здравствуйте, Владимир. Нужен обязательно поиск по документации, и побольше примеров не только по дизайну. Огромное спасибо команде WebAsyst, Ваши разработки радуют.
ответитьДобавлю к вышеозначенному: нужна документация в PDF.
ответитьДобрый вечер, немного предложений
ответить1. Завести раздел - сниппеты, маленькие лайфхаки, которые в том числе, могу пополнять и пользователи
2. Все же опубликовать документацию о возможности интеграции встроенного редактора, дабы не изобретать велосипед и не использовать какой нибудь сторонний TinyMCE, все же ваш очень удобный!
3. Добавить примеры создание роутинга для ЧПУ от и до
4. Было бы не плохо, видеть набор всех доступных функций в виде WIKI по алфавиту или функционалу.
5. Расписать подробнее возможности некоторых функций, приведу пример. Есть функция ресайза изображений $img->resize(100, 100, waImage::WIDTH); в документации не указанно, что можно вставить HEIGHT и т.д.
6. В документации не указано, что есть возможность в waModel определить свой запрос к БД и создания функцию вызова.
7. Раздел "Интерфейс" невозможно полноценно использовать, т.к. допустим все иконки идут одним файлом, и приходится перебирать классы, чтобы отобразить необходимые.
8. Обновить описание папок файловой структуры фреймворка, устарела
9. Хотелось бы иметь в ядре фреймворка функционал разделения прав групп пользователей.
Было что-то еще, вспомню, допишу )) Если что-то реализовано, возможно не увидел )
Спасибо!
ответить7. В приложении Разработка есть все иконки с классами. В будущем сделаем в разделе Интерфейс аналогично.
ответить9. Такой функционал есть. В приложении контакты вы можете создавать группы пользователей и назначать права для групп.
За остальные пункты спасибо, будем делать обязательно.
Я бы хотел больше туториалов и демо-приложений. Чтобы проще было разбираться новичкам.
ответитьесли тема еще актуальна, то жутко не хватает описания стандартных методов и переменных.
ответитьХочется писать с такого хорошего быстрого старта как на вашем фрейворке, но документация для разработчиков мягко скажем не достаточная... что-то вроед вот этого - http://docs.livestreetcms.com/api/ очень хотелось бы увидеть