我可以使用/適應Kohana用戶指南模塊來為我的應用程序創建幫助頁面嗎？

Question

我想為使用Kohana框架構建的應用程序創建用戶指南，並且我想知道是否有一種方法可以為此目的使用Kohana用戶指南模塊。

我了解如何為創建的新模塊添加用戶指南信息，以及如何在API中包含我的類，但是我想為實際的應用程序用戶（而不是應用程序開發人員）構建第二個單獨的用戶指南。

起初，我以為我只是嘗試將應用程序幫助頁面添加到APPPATH / guide的主要用戶指南中。 我嘗試添加“應用程序/指南”目錄，並在其中放置一個名為menu.md的文件，但最終只是替換了用戶指南中的Kohana菜單。 將文件重命名為menu.myapp.md后，它根本不會顯示。

因此，我想到可以簡單地編輯模塊/用戶指南/指南/menu.md為我的應用添加部分，並為每個應用組件添加markdown文件。 但實際上，為應用程序用戶提供完全獨立的用戶指南會更好，因為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 docs”及其他所有內容。