1

Kohana フレームワークを使用して構築しているアプリケーションのユーザーガイドを作成したいのですが、この目的のために Kohana ユーザーガイド モジュールを使用できる方法があるかどうか疑問に思っています。

作成する新しいモジュールのユーザーガイド情報を追加する方法と、API にクラスを含める方法は理解していますが、アプリ開発者ではなく、実際のアプリケーション ユーザー向けに別のユーザーガイドを作成したいと考えています。

最初は、APPPATH/guide のメイン ユーザーガイドにアプリのヘルプ ページを追加してみようと思っていました。「application/guide」ディレクトリを追加して、そこに menu.md というファイルを配置しようとしましたが、ユーザーガイドの Kohana メニューが置き換えられてしまいました。ファイルの名前を menu.myapp.md に変更した後、まったく表示されません。

そのため、modules/userguide/guide/menu.md を編集してアプリのセクションを追加し、同様に各アプリ コンポーネントのマークダウン ファイルを追加することができます。しかし実際には、Kohana のドキュメントはアプリ ユーザーには関係ないため、アプリ ユーザー用に完全に別のユーザー ガイドを作成する方がはるかに優れています。

これについて最善の方法は何ですか?ユーザーガイド モジュール全体の複製を作成し、ルーティングを変更する必要がありますか? または、1 つのバージョンのモジュールを使用して両方のユーザーガイドをセットアップする方法はありますか? それとも、まったく間違ったツリーを吠えていますか? アプリの「ヘルプ」ページを作成するのに適した他のモジュール/アプローチはありますか?

よろしくお願いします。

4

1 に答える 1

0

はい、ユーザーガイドを使用してアプリケーションのドキュメントを作成できます。例が必要な場合は、次のリンクを確認してください。

設定を変更して非表示にしない限り、「api docs」とその他すべてを取得できることに注意してください。

于 2011-06-25T16:05:16.957 に答える