Skip to content

docs: ドキュメントを現在のリポジトリ状態に合わせて更新#217

Open
Copilot wants to merge 3 commits into
mainfrom
copilot/update-documentation-to-latest
Open

docs: ドキュメントを現在のリポジトリ状態に合わせて更新#217
Copilot wants to merge 3 commits into
mainfrom
copilot/update-documentation-to-latest

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 10, 2026

各ドキュメントが削除済みの legacy サービスや旧技術スタック(MUI、SolidJS)を参照しており、リポジトリの実態と乖離していた。

変更内容

各ドキュメントをリポジトリの現在の状態に合わせて修正。

変更の種類

  • バグ修正(Bug fix)
  • 新機能(New feature)
  • 破壊的変更(Breaking change)
  • ドキュメント更新(Documentation update)
  • リファクタリング(Refactoring)
  • パフォーマンス改善(Performance improvement)
  • テスト追加・修正(Test update)
  • その他(Other)

関連Issue

Closes #

変更の詳細

readme.md

  • バッジから SolidJS・MUI を削除 → Tailwind CSS バッジを追加
  • Dev Container 起動オプションから legacy-frontendlegacy-syllabus-frontend を削除
  • 開発環境ポート一覧(3001/4000)を削除
  • プロジェクト構成セクションの legacy サービスを削除
  • 使用技術セクションを整理(SolidJS/MUI → shadcn/ui)
  • アーキテクチャ図を簡略化(rishu builder viewer ノード削除)

nginx/README.md

  • 概要・設定例・確認手順から syllabus-frontendbuilder.* ルーティング)を削除(実際の default.conf.template に該当ルートは存在しない)

frontend/README.md

  • create-next-app の汎用 boilerplate を廃棄
  • 実際のサービス向け README に刷新(技術スタック・ディレクトリ構造・Dev 環境・テスト・主要機能・トラブルシューティング)

CONTRIBUTING.md

  • Dev Container 選択肢から syllabus-frontend を削除
  • TypeScript サービス一覧から syllabus-frontend を削除
  • スタイリングガイドを MUI → Tailwind CSS / shadcn/ui に更新
  • syllabus-frontend 統合に関する stale な TODO コメントを削除

テスト

  • 既存のテストが通ることを確認
  • 新しいテストを追加
  • 手動でテスト実施

テスト内容

ドキュメント変更のみ。コード変更なし。

チェックリスト

  • コードが正常に動作することを確認した
  • 適切なコメントを追加した(必要に応じて)
  • ドキュメントを更新した(必要に応じて)
  • 新しい警告が発生していないことを確認した
  • 依存関係の追加や更新がある場合、その理由を説明した

スクリーンショット

N/A(ドキュメント変更のみ)

その他

docker-compose.dev.yml および .devcontainer/ には legacy-frontendlegacy-syllabus-frontend のエントリが残っているが、対応するソースディレクトリは存在しないため、ドキュメント上では記載しない方針とした。

Copilot AI linked an issue Apr 10, 2026 that may be closed by this pull request
@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 10, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
rishu-app Ready Ready Preview, Comment Apr 11, 2026 0:09am
rishu-app-storybook Ready Ready Preview, Comment Apr 11, 2026 0:09am

Copilot AI changed the title [WIP] Update README and CONTRIBUTING files to match latest repository state docs: ドキュメントを現在のリポジトリ状態に合わせて更新 Apr 10, 2026
Copilot AI requested a review from ToYama170402 April 10, 2026 13:04
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

レガシーサービス(SolidJS/MUI/旧frontend等)への参照が残っていた各種README/ガイドを、現行のリポジトリ構成・技術スタック(Next.js + Tailwind CSS + shadcn/ui、nginxの実際のルーティング等)に合わせて更新するPRです。

Changes:

  • ルートREADMEから legacy サービス/旧スタック参照を削除し、現行スタック表記とアーキテクチャ図を整理
  • nginx のREADMEから builder.*(syllabus-frontend)向け記述を削除し、実際の default.conf.template と整合
  • frontend/README を実プロダクト向けの説明に刷新(セットアップ、テスト、機能、トラブルシューティング等)
  • CONTRIBUTING の Dev Container / スタイリングガイドを現状(Tailwind/shadcn/ui)に更新

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File Description
readme.md legacy 記述の削除、利用技術・構成・図を現状に合わせて更新
nginx/README.md 実設定に存在しない builder.* ルーティング記述を削除
frontend/README.md create-next-app boilerplate を置換し、現行開発手順/テスト/機能を明文化
CONTRIBUTING.md Dev Container 選択肢やスタイリング方針を Tailwind/shadcn/ui 前提に更新

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread frontend/README.md
Comment on lines +76 to +78

# 型チェック
pnpm typecheck
Comment thread readme.md
Comment on lines 79 to 82
開発環境のポート割り当て:
- `frontend` (新実装): http://localhost:3000
- `legacy-frontend` (旧実装): http://localhost:3001
- `legacy-syllabus-frontend` (旧実装): http://localhost:4000
- `frontend`: http://localhost:3000
- `syllabus-backend`: http://localhost:8080

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.

[Bug]: ドキュメントが古い

3 participants