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

Question

我想为我正在使用Kohana框架构建的应用程序创建一个用户指南，我想知道是否有一种方法可以使用Kohana用户指南模块来实现这一目的。

我知道如何为我创建的新模块添加用户指南信息，以及如何在API中包含我的类，但我想为实际的应用程序用户而不是应用程序开发人员构建第二个单独的用户指南。

起初，我只是想尝试在APPPATH/guide的主用户指南中添加应用程序帮助页面。我尝试添加一个“应用程序/指南”目录，并在其中放置了一个名为menu.md的文件，但最终替换了用户指南中的Kohana菜单。将文件重命名为menu.myapp.md后，它根本不显示。

因此，我突然想到，我可以简单地编辑modules/userguide/guide/menu.md来为我的应用程序添加部分，同样地，为每个应用程序组件添加标记文件。但实际上，为应用程序用户提供一个完全独立的用户指南要好得多，因为Kohana文档与他们无关。

做这件事最好的方法是什么？我是否应该创建整个用户指南模块的副本并修改路由，&c？或者，是否有某种方法可以使用一个模块版本来设置两个用户指南？或者我完全找错人了？是否有其他模块/方法可以更好地构建应用程序的“帮助”页面？

提前感谢您的帮助！

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文档“和其他所有内容，除非您更改配置以隐藏它们。