Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README.md の改訂 (パターン集の追加・スリム化) #883

Merged
merged 5 commits into from
Feb 6, 2025

Conversation

tbrand
Copy link
Contributor

@tbrand tbrand commented Feb 5, 2025

変更内容の説明

README.md を改訂した

  • パターン集を追加することで、GenU の多様な使われ方をナビゲートできるようにする
  • スリム化することでメンテナンスコストを抑える (デプロイオプションのアンカーリンクなど)
  • ドキュメントのリンクを全て gh-pages に変更

チェック項目

  • npm run lint を実行した
  • 関連するドキュメントを修正した
  • 手元の環境で動作確認済み
  • npm run cdk:test を実行しスナップショット差分がある場合は npm run cdk:test:update-snapshot を実行してスナップショットを更新した

関連する Issue

なし

README.md Outdated

<img src="./docs/assets/images/usecase_agent.gif"/>
</details>
<div align="center">
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mkdocs の GitHub Page でも動作させるために以下の変更が必要でした。

  1. md_in_html を動作させるため div に markdown="1" attribute の追加
  2. img の src を relative path に変更

修正すると以下になります。

<div markdown="1"align="center">
  <h1>Generative AI Use Cases JP (略称:GenU)</h1>

  [![](https://img.shields.io/badge/%E3%83%89%E3%82%AD%E3%83%A5%E3%83%A1%E3%83%B3%E3%83%88-%E6%9C%80%E6%96%B0-blue)](https://aws-samples.github.io/generative-ai-use-cases-jp/index.html) [![](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/aws-samples/generative-ai-use-cases-jp/blob/main/LICENSE) [![](https://github.com/aws-samples/generative-ai-use-cases-jp/actions/workflows/node.js.yml/badge.svg)](https://github.com/aws-samples/generative-ai-use-cases-jp/actions/workflows/node.js.yml) [![](https://github.com/aws-samples/generative-ai-use-cases-jp/actions/workflows/browser-extension.yml/badge.svg)](https://github.com/aws-samples/generative-ai-use-cases-jp/actions/workflows/browser-extension.yml)

  生成 AI を安全に業務活用するための、ビジネスユースケース集を備えたアプリケーション実装

  <img src="docs/assets/images/sc_lp.png" alt="生成 AI を安全に業務活用するための、ビジネスユースケース集を備えたアプリケーション実装" width="68%">
</div>

README.md Outdated
</details>


<details>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

こちらも markdown="1" を追加した上で、Markdown のリンクにすれば GitHub Page と GitHub 両方で動作するはずです。

<details markdown="1">
... [Amazon Kendra](docs/DEPLOY_OPTION.html#rag-チャット-amazon-kendra-ユースケースの有効化)

@tbrand tbrand merged commit 50b298c into main Feb 6, 2025
2 checks passed
@tbrand tbrand deleted the revise-readme branch February 6, 2025 05:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants