我可以使用/适应Kohana用户指南模块来为我的应用程序创建帮助页面吗？

Question

I'd like to create a userguide for the application I'm building using the Kohana framework, and I'm wondering if there's a way I can use the Kohana userguide module for this purpose.

I understand how to add userguide info for new modules that I create, and how to include my classes in the API, but I want to build a second, separate userguide for the actual application user, as opposed to the app developers.

At first, I thought I'd just try adding app help pages to the main userguide at APPPATH/guide. I tried adding a "application/guide" directory, and put a file in there called menu.md, but that just ended up replacing the Kohana menu in the userguide. After renaming the file to menu.myapp.md, it doesn't show up at all.

So then it occurs to me that I could simple edit modules/userguide/guide/menu.md to add sections for my app, and likewise add markdown files for each app component. But really it would be much better to have a completely separate userguide for app users since the Kohana documentation isn't relevant for them.

What's the best way to go about this? Should I create a duplicate of the entire userguide module and modify the routing, &c.? Or is there some way to set up both userguides using the one version of the module? Or am I barking up the wrong tree altogether? Is there some other module/approach that would be better for building "Help" pages for the app?

Thanks in advance for your help!

Answer 1

Yes, you can make docs for your application with the userguide. If you want examples, check out these links:

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

Note that you'll still get "api docs" and everything else, unless you change the config to hide them.