我想为我使用 Kohana 框架构建的应用程序创建一个用户指南，我想知道是否有办法使用 Kohana 用户指南模块来实现此目的。
我了解如何为我创建的新模块添加用户指南信息，以及如何将我的类包含在 API 中，但我想为实际应用程序用户（而不是应用程序开发人员）构建第二个单独的用户指南。
起初，我想我只是尝试将应用程序帮助页面添加到 APPPATH/guide 的主用户指南中。我尝试添加一个“application/guide”目录，并在其中放置一个名为 menu.md 的文件，但这最终只是替换了用户指南中的 Kohana 菜单。将文件重命名为 menu.myapp.md 后，它根本不显示。
因此，我突然想到，我可以简单地编辑 module/userguide/guide/menu.md 来为我的应用程序添加部分，并同样为每个应用程序组件添加 markdown 文件。但实际上，为应用程序用户提供完全独立的用户指南会更好，因为 Kohana 文档与他们无关。
解决这个问题的最佳方法是什么？我是否应该创建整个用户指南模块的副本并修改路由等？或者是否有某种方法可以使用该模块的一个版本来设置两个用户指南？或者我完全找错了树？是否有其他模块/方法更适合为应用程序构建“帮助”页面？
预先感谢您的帮助！
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!
发布评论
评论（1）
是的，您可以使用用户指南为您的应用程序制作文档。如果您需要示例，请查看以下链接：
请注意，您仍然会获得“api 文档”和其他所有内容，除非您更改配置以隐藏它们。
Yes, you can make docs for your application with the userguide. If you want examples, check out these links:
Note that you'll still get "api docs" and everything else, unless you change the config to hide them.