问题描述
|
我想为使用Kohana框架构建的应用程序创建用户指南,并且我想知道是否有一种方法可以为此目的使用Kohana用户指南模块。
我了解如何为我创建的新模块添加用户指南信息,以及如何在API中包含我的类,但是我想为实际的应用程序用户(而不是应用程序开发人员)构建第二个单独的用户指南。
起初,我认为我只是尝试将应用程序帮助页面添加到APPPATH / guide的主要用户指南中。我尝试添加一个\“ application / guide \”目录,并在其中放置一个名为menu.md的文件,但是最终替换了用户指南中的Kohana菜单。将文件重命名为menu.myapp.md后,它根本不会显示。
因此,我想到可以简单地编辑模块/用户指南/指南/menu.md为我的应用添加部分,并为每个应用组件添加markdown文件。但实际上,为应用程序用户提供完全独立的用户指南会更好,因为Kohana文档与他们无关。
最好的方法是什么?是否应该创建整个用户指南模块的副本并修改路由&c。还是有某种方法可以使用该模块的一个版本来设置两个用户指南?还是我完全把错误的树种了?还有其他一些模块/方法会更好地为应用程序构建“帮助”页面吗?
在此先感谢您的帮助!
解决方法
是的,您可以使用用户指南为您的应用制作文档。如果您需要示例,请查看以下链接:
https://github.com/zombor/Auto-Modeler/blob/master/config/userguide.php
https://github.com/zombor/Auto-Modeler/tree/master/guide/auto-modeler
请注意,除非更改配置以隐藏它们,否则您仍然会获得“ api docs \”及其他所有信息。