LLM: ナレッジ管理サンプルアプリのドキュメントを追加（ドキュメント） - #78
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
ナレッジ管理（KM）サンプルアプリおよび EC サンプルアプリのドキュメントを拡充し、サンプル全体のトップインデックスを再構成する PR です。KM の構成・セットアップ・機能（WebApi/全文検索/セキュリティ/i18n など）と、EC の各実装方式（Java/JSP・Groovy/GroovyTemplate・Vue.js/WebAPI）向けの説明や参照リンク整備、関連スクリーンショット追加を行っています。
Changes:
- KM（問合せ・ナレッジ管理）サンプルの新規ドキュメント一式を追加（EE 追加パッケージ/Bedrock 連携含む）
- EC サンプルのドキュメント構造を
sample/ec/...配下へ整理し、相対リンクを調整 - サンプル全体のトップページを「EC」「KM」への案内形式に刷新し、README/.gitignore を更新
Reviewed changes
Copilot reviewed 57 out of 283 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| sample/src/docs/asciidoc/km/index.adoc | KM ドキュメントのトップ（章構成・include 定義）を追加 |
| sample/src/docs/asciidoc/km/overview.adoc | KM サンプル概要（登場人物・機能・EE 追加機能）を追加 |
| sample/src/docs/asciidoc/km/businessflow.adoc | KM 業務フロー（質問者/回答者、EE only 操作含む）を追加 |
| sample/src/docs/asciidoc/km/setup.adoc | KM セットアップ手順（mise コマンド等）を追加 |
| sample/src/docs/asciidoc/km/globalsettings.adoc | KM 利用前のグローバル設定（ロール/全文検索）を追加 |
| sample/src/docs/asciidoc/km/features.adoc | KM 機能章のハブ（include 群）を追加 |
| sample/src/docs/asciidoc/km/features_layout.adoc | KM フロント構成（JSP + Vue SPA、埋め込み変数等）を追加 |
| sample/src/docs/asciidoc/km/features_webapi.adoc | KM WebApi 連携（useApi/composable と Command 側）を追加 |
| sample/src/docs/asciidoc/km/features_errorhandler.adoc | KM 共通エラーハンドラー方針（SPA 前提）を追加 |
| sample/src/docs/asciidoc/km/features_entity.adoc | KM Entity 構成・注意点（参照配列差、pub/public 変換）を追加 |
| sample/src/docs/asciidoc/km/features_fulltextsearch.adoc | KM 全文検索の利用パターン説明を追加 |
| sample/src/docs/asciidoc/km/features_security.adoc | KM セキュリティ（ロール/参照範囲/CSRF）説明を追加 |
| sample/src/docs/asciidoc/km/features_multilingual.adoc | KM i18n 方針（window.lang・fallback 等）を追加 |
| sample/src/docs/asciidoc/km/resources.adoc | KM リソース章のハブ（メタデータ/メッセージ include）を追加 |
| sample/src/docs/asciidoc/km/resources_metadata.adoc | KM メタデータ定義（注釈・CommandList 等）説明を追加 |
| sample/src/docs/asciidoc/km/resources_message.adoc | KM メッセージ管理（ja/en、サーバ側メッセージ）説明を追加 |
| sample/src/docs/asciidoc/km/relatedfeatures.adoc | KM 関連機能（EE 追加パッケージリンク）を追加 |
| sample/src/docs/asciidoc/km/eepackage/index.adoc | KM EE 追加パッケージのトップを追加 |
| sample/src/docs/asciidoc/km/eepackage/setup.adoc | KM EE セットアップ（Bedrock・service-config）説明を追加 |
| sample/src/docs/asciidoc/km/eepackage/ai_inquiry.adoc | KM EE: 問合せ AI 機能（Invoker/summary/tag）説明を追加 |
| sample/src/docs/asciidoc/km/eepackage/ai_knowledge.adoc | KM EE: ナレッジ AI 機能（generate/tag/merge）説明を追加 |
| sample/src/docs/asciidoc/km/eepackage/ai_rag.adoc | KM EE: RAG/類似ナレッジ提案（KB・引用元逆引き）説明を追加 |
| sample/src/docs/asciidoc/index.adoc | サンプル全体トップを EC/KM への案内形式に更新 |
| sample/src/docs/asciidoc/ec/index.adoc | EC サンプルのトップ（include 群・メニュー属性）を追加 |
| sample/src/docs/asciidoc/ec/overall.adoc | EC 全体像（管理/消費者向け、画面イメージ）を追加 |
| sample/src/docs/asciidoc/ec/businessflow.adoc | EC 業務フロー（購入/問合せ/会員登録/検索、管理側）を追加 |
| sample/src/docs/asciidoc/ec/globalsettings.adoc | EC グローバル設定の参照リンク（相対パス）を調整 |
| sample/src/docs/asciidoc/ec/implementation.adoc | EC 実装方式（Java/JSP・GroovyGT・Vue/WebApi）への導線を追加 |
| sample/src/docs/asciidoc/ec/javajsp/index.adoc | Java/JSP 版の出力パス属性を sample/ec/... に調整 |
| sample/src/docs/asciidoc/ec/javajsp/overview.adoc | Java/JSP 版の概要を追加 |
| sample/src/docs/asciidoc/ec/javajsp/setup.adoc | Java/JSP 版の gettingstarted 参照リンクを調整 |
| sample/src/docs/asciidoc/ec/javajsp/features.adoc | Java/JSP 版の機能章ハブを追加 |
| sample/src/docs/asciidoc/ec/javajsp/features_layout.adoc | Java/JSP 版のレイアウト説明を追加 |
| sample/src/docs/asciidoc/ec/javajsp/features_beanvalidation.adoc | Java/JSP 版の Bean Validation 説明を追加 |
| sample/src/docs/asciidoc/ec/javajsp/features_entity.adoc | Java/JSP 版の Entity 説明を追加 |
| sample/src/docs/asciidoc/ec/javajsp/features_errorurlselector.adoc | Java/JSP 版の ErrorUrlSelector 説明を追加 |
| sample/src/docs/asciidoc/ec/javajsp/features_reportoutput.adoc | 帳票出力の開発者ガイド参照リンクを調整 |
| sample/src/docs/asciidoc/ec/javajsp/features_buildinmethod.adoc | Java/JSP 版の EL 関数説明を追加 |
| sample/src/docs/asciidoc/ec/javajsp/features_webapi.adoc | WebApi 作成方法リンクの相対パスを調整 |
| sample/src/docs/asciidoc/ec/javajsp/features_security.adoc | Java/JSP 版のセキュリティ対策説明を追加 |
| sample/src/docs/asciidoc/ec/javajsp/features_multilingual.adoc | Java/JSP 版の多言語対応説明を追加 |
| sample/src/docs/asciidoc/ec/javajsp/resourcefiles.adoc | Java/JSP 版のリソース章ハブを追加 |
| sample/src/docs/asciidoc/ec/javajsp/resourcefiles_metadata.adoc | Java/JSP 版のメタデータ定義説明を追加 |
| sample/src/docs/asciidoc/ec/javajsp/resourcefiles_message.adoc | Java/JSP 版のメッセージファイル説明を追加 |
| sample/src/docs/asciidoc/ec/javajsp/resourcefiles_beanvalidation.adoc | Java/JSP 版の ValidationMessages 説明を追加 |
| sample/src/docs/asciidoc/ec/javajsp/configfiles.adoc | Java/JSP 版の service-config 設定例を追加 |
| sample/src/docs/asciidoc/ec/javajsp/testcode.adoc | Java/JSP 版のテストコード説明を追加 |
| sample/src/docs/asciidoc/ec/vuejswebapi/index.adoc | Vue.js/WebAPI 版の出力パス属性を sample/ec/... に調整 |
| sample/src/docs/asciidoc/ec/vuejswebapi/overview.adoc | Vue.js/WebAPI 版の概要を追加 |
| sample/src/docs/asciidoc/ec/vuejswebapi/setup.adoc | Vue.js/WebAPI 版の gettingstarted 参照リンクを調整 |
| sample/src/docs/asciidoc/ec/vuejswebapi/features.adoc | Vue.js/WebAPI 版の機能章ハブを追加 |
| sample/src/docs/asciidoc/ec/vuejswebapi/features_layout.adoc | Vue.js/WebAPI 版のレイアウト説明を追加 |
| sample/src/docs/asciidoc/ec/vuejswebapi/features_beanvalidation.adoc | Vue.js/WebAPI 版の Bean Validation 説明を追加 |
| sample/src/docs/asciidoc/ec/vuejswebapi/features_entity.adoc | Vue.js/WebAPI 版の Entity 説明を追加 |
| sample/src/docs/asciidoc/ec/vuejswebapi/features_errorhandler.adoc | Vue.js/WebAPI 版の axios interceptor 例を追加 |
| sample/src/docs/asciidoc/ec/vuejswebapi/features_reportoutput.adoc | Vue.js/WebAPI 版の帳票説明リンクを追加 |
| sample/src/docs/asciidoc/ec/vuejswebapi/features_webapi.adoc | WebApi 作成方法リンクの相対パスを調整 |
| sample/src/docs/asciidoc/ec/vuejswebapi/features_security.adoc | Token Check 等の参照リンク相対パスを調整 |
| sample/src/docs/asciidoc/ec/vuejswebapi/features_mutlilingual.adoc | Vue.js/WebAPI 版の多言語対応説明を追加 |
| sample/src/docs/asciidoc/ec/vuejswebapi/resources.adoc | Vue.js/WebAPI 版のリソース章ハブを追加 |
| sample/src/docs/asciidoc/ec/vuejswebapi/resources_metadata.adoc | Vue.js/WebAPI 版のメタデータ説明を追加 |
| sample/src/docs/asciidoc/ec/vuejswebapi/resources_message.adoc | Vue.js/WebAPI 版の i18n メッセージファイル説明を追加 |
| sample/src/docs/asciidoc/ec/vuejswebapi/resources_beanvalidation.adoc | Vue.js/WebAPI 版の ValidationMessages 説明を追加 |
| sample/src/docs/asciidoc/ec/groovygtmpl/index.adoc | Groovy/GT 版の出力パス属性を sample/ec/... に調整 |
| sample/src/docs/asciidoc/ec/groovygtmpl/overview.adoc | Groovy/GT 版の概要を追加 |
| sample/src/docs/asciidoc/ec/groovygtmpl/setup.adoc | Groovy/GT 版の gettingstarted 参照リンクを調整 |
| sample/src/docs/asciidoc/ec/groovygtmpl/features.adoc | Groovy/GT 版の機能章ハブを追加 |
| sample/src/docs/asciidoc/ec/groovygtmpl/features_layout.adoc | Groovy/GT 版のレイアウト説明を追加 |
| sample/src/docs/asciidoc/ec/groovygtmpl/features_utilityclass.adoc | UtilityClass の利用説明を追加 |
| sample/src/docs/asciidoc/ec/groovygtmpl/features_beanvalidation.adoc | Groovy/GT 版の Bean Validation 説明を追加 |
| sample/src/docs/asciidoc/ec/groovygtmpl/features_entity.adoc | Groovy/GT 版の Entity 説明を追加 |
| sample/src/docs/asciidoc/ec/groovygtmpl/features_errorurlselector.adoc | GroovyTemplate 関数参照リンクの相対パスを調整 |
| sample/src/docs/asciidoc/ec/groovygtmpl/features_reportoutput.adoc | 帳票出力の参照リンク相対パスを調整 |
| sample/src/docs/asciidoc/ec/groovygtmpl/features_buildinmethod.adoc | GroovyTemplate のビルトイン関数説明を追加（新配置） |
| sample/src/docs/asciidoc/ec/groovygtmpl/features_webapi.adoc | WebApi 作成方法リンクの相対パスを調整 |
| sample/src/docs/asciidoc/ec/groovygtmpl/features_security.adoc | 記述形式リンクの相対パスを調整 |
| sample/src/docs/asciidoc/ec/groovygtmpl/features_multilingual.adoc | 多言語テンプレート作成手順を追加 |
| sample/src/docs/asciidoc/ec/groovygtmpl/resources.adoc | Groovy/GT 版のリソース章ハブを追加 |
| sample/src/docs/asciidoc/ec/groovygtmpl/resources_message.adoc | GroovyTemplate 関数参照リンクの相対パスを調整 |
| sample/src/docs/asciidoc/ec/groovygtmpl/resources_beanvalidation.adoc | Bean Validation メッセージ定義（メタデータ）説明を追加 |
| sample/src/docs/asciidoc/ec/groovygtmpl/resources_staticresource.adoc | Static Resource 参照リンクの相対パスを調整 |
| sample/src/docs/asciidoc/ec/adminconsole/index.adoc | Admin Console 共通設定の出力パス属性を sample/ec/... に調整 |
| sample/src/docs/asciidoc/ec/adminconsole/bulkupdate.adoc | 一括更新画面の設定手順を追加 |
| sample/src/docs/asciidoc/ec/adminconsole/searchview_bulkupdate.adoc | 一括更新画面の参照リンク相対パスを調整 |
| sample/src/docs/asciidoc/ec/adminconsole/calendar.adoc | Calendar 作成方法リンクの相対パスを調整 |
| sample/src/docs/asciidoc/ec/adminconsole/treeview.adoc | TreeView 作成方法リンクの相対パスを調整 |
| sample/src/docs/asciidoc/ec/adminconsole/report.adoc | 帳票テンプレート設定リンクの相対パスを調整 |
| sample/src/docs/asciidoc/ec/adminconsole/entitymultilingual.adoc | i18n データ多言語リンクの相対パスを調整 |
| sample/src/docs/asciidoc/ec/eepackage/index.adoc | EE 追加パッケージの出力パス属性を sample/ec/... に調整 |
| sample/src/docs/asciidoc/ec/eepackage/setup.adoc | EE パッケージ導入手順を追加 |
| sample/src/docs/asciidoc/ec/eepackage/workflow.adoc | Workflow 参照リンクの相対パスを調整 |
| sample/src/docs/asciidoc/ec/eepackage/savedlist.adoc | SavedList 参照リンクの相対パスを調整 |
| sample/src/docs/asciidoc/ec/eepackage/entitylisting.adoc | EntityListing 参照リンクの相対パスを調整 |
| sample/src/docs/asciidoc/ec/eepackage/aggregation.adoc | Aggregation 参照リンクの相対パスを調整 |
| sample/src/docs/asciidoc/ec/eepackage/dashboard.adoc | Dashboard 参照リンクの相対パスを調整 |
| sample/src/docs/asciidoc/ec/eepackage/cube.adoc | Cube 参照リンクの相対パスを調整 |
| sample/src/docs/asciidoc/ec/images/sample-ec_mantainance-top-page-fulltext-search.png | EC 管理画面のスクリーンショットを追加 |
| sample/src/docs/asciidoc/ec/images/sample-ec_consumer-top-page-transition.png | EC 画面遷移のスクリーンショットを追加 |
| sample/src/docs/asciidoc/ec/groovygtmpl/images/sample-ec_groovy-gtmpl-static-resource-resources.png | Groovy/GT の Static Resource 関連スクリーンショット追加 |
| sample/src/docs/asciidoc/ec/groovygtmpl/images/sample-ec_groovy-gtmpl-multilang-validationmessages.png | Groovy/GT の多言語 ValidationMessages 画面例を追加 |
| sample/src/docs/asciidoc/groovygtmpl/features_buildinmethod.adoc | 旧パスの GroovyTemplate 関数説明ファイルを削除 |
| sample/README.adoc | KM ドキュメントへの Top Index リンクを追加 |
| .gitignore | .claude/settings.local.json を ignore 追加 |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
サポートデスク業務を題材にした新規サンプルアプリケーションのドキュメントを追加する。
sample/indexはサンプルの選択ページに改修し、そこから既存のオンライン書店サンプルと今回の新規サンプルを選択させる形とする。