1

我想为我正在使用 Kohana 框架构建的应用程序创建一个用户指南,我想知道是否有办法为此目的使用 Kohana 用户指南模块。

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

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

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

解决这个问题的最佳方法是什么?我应该创建整个用户指南模块的副本并修改路由等吗?或者有什么方法可以使用模块的一个版本来设置两个用户指南?还是我完全找错了树?是否有其他一些模块/方法可以更好地为应用程序构建“帮助”页面?

在此先感谢您的帮助!

4

1 回答 1

0

是的,您可以使用用户指南为您的应用程序制作文档。如果您需要示例,请查看以下链接:

请注意,除非您更改配置以隐藏它们,否则您仍然会获得“api docs”和其他所有内容。

于 2011-06-25T16:05:16.957 回答