Обновление Userguide

Вам не нравился прежний вид официальной документации? Неудобная нафигация и странные URL? Радуйтесь, вчера было объявлено о начале заполнения нового Userguide.

Итак, текущее состояние документации можно посмотреть здесь (пустовато пока, все надо переносить из имеющихся источников). Согласитесь, выглядит посимпатичнее прежнего варианта. API в целом практически не поменялся, но оформление изменено, я считаю, в положительную сторону.

Что внутри

Документация собирается из подключенных модулей + собственно файлов фреймворка (папка system). Например, для модуля Auth документация будет лежать в MODPATH/auth/guide/auth, а для ядра — в SYSPATH/guide/kohana. Файлы картинок (если используются) размещаются в MODPATH/auth/media/guide/auth и SYSPATH/media/guide/system. Для каждого модуля должен быт свой индексный файл index.md и навигационное меню menu.md в корне папки guide. Текст по-прежнему использует разметку Markdown + небольшие дополнения.

Внесение изменений

Если есть желание заняться написанием/редактированием Userguide, делаете форк от нужного модуля (форки брать у bluehawk) и работаете с веткой (branch) docs (и только с ней!), а затем отправляете обратно через push request. Для тех, кто не дружит с git, можно просто отправить issue.

Обсудить новый вид можно в соответствующей ветке официального форума. Более подробно почитать про новый Userguide можно в readme к проекту.

PS. Только вот опять придется переводить документацию с нуля…