Могу ли я использовать / адаптировать модуль руководства пользователя Kohana для создания страниц справки для моего приложения?

Question

Я хотел бы создать руководство пользователя для приложения, которое я создаю с использованием инфраструктуры Kohana, и мне интересно, есть ли способ, которым я могу использовать модуль руководства пользователя Kohana для этой цели.

Я понимаю, как добавить информацию в руководстве пользователя для новых модулей, которые я создаю, и как включить мои классы в API, но я хочу создать второе, отдельное руководство пользователя для реального пользователя приложения, в отличие от разработчиков приложений.

Сначала я подумал, что просто попробую добавить справочные страницы приложения в основное руководство пользователя в APPPATH/guide. Я попытался добавить каталог "application/guide" и поместил туда файл с именем menu.md, но в итоге он заменил меню Kohana в руководстве пользователя. После переименования файла в menu.myapp.md он вообще не отображается.

Тогда мне пришло в голову, что я могу просто отредактировать модули / userguide / guide / menu.md, чтобы добавить разделы для моего приложения, а также добавить файлы уценки для каждого компонента приложения. Но на самом деле было бы гораздо лучше иметь совершенно отдельное руководство для пользователей приложений, поскольку документация по Kohana для них не актуальна.

Какой лучший способ пойти по этому поводу? Должен ли я создать дубликат всего пользовательского модуля и изменить маршрут и т. Д.? Или есть какой-то способ настроить оба руководства, используя одну версию модуля? Или я вообще лаю не на том дереве? Есть ли какой-то другой модуль / подход, который был бы лучше для создания страниц "Справки" для приложения?

Заранее спасибо за помощь!

Answer 1

Да, вы можете создавать документы для своего приложения с помощью руководства пользователя. Если вы хотите примеры, проверьте эти ссылки:

• https://github.com/zombor/Auto-Modeler/blob/master/config/userguide.php
• https://github.com/zombor/Auto-Modeler/tree/master/guide/auto-modeler

Обратите внимание, что вы все равно получите "api docs" и все остальное, если вы не измените конфигурацию, чтобы скрыть их.