feat: GitHub Copilotの指示を追加#68
Conversation
ootomonaiso
commented
May 23, 2025
ootomonaiso
commented
- GitHub Copilotに関するプロジェクトの概要、コーディング規約、補完方針を含む新しいドキュメントを作成しました。
- docusaurus.config.jsのカテゴリ追加方法、themeConfigのitems登録方法、footerのlinks登録方法についての具体的な指示を記載しました。
- GitHub Copilotに関するプロジェクトの概要、コーディング規約、補完方針を含む新しいドキュメントを作成しました。 - docusaurus.config.jsのカテゴリ追加方法、themeConfigのitems登録方法、footerのlinks登録方法についての具体的な指示を記載しました。
Copilotの補完に関する指示を更新し、ファイル名を正しい拡張子に変更しました。
There was a problem hiding this comment.
Pull Request Overview
Adds a new Copilot instructions document outlining project overview, coding conventions, and specific guidance for registering categories in Docusaurus configuration.
- Introduces
.github/copilot-instructions.mdwith Copilot completion guidelines. - Provides step-by-step examples for modifying
docusaurus.config.ts/js, theme items, and footer links. - Specifies project tech stack and build/deployment details.
| Copilot は以下の方針に従って補完してください： | ||
|
|
||
| ### docusaurus.config.tsの補完 | ||
| #### 新しくカテゴリを作成した場合、``docusaurus.config.js``にカテゴリを追加してください。 |
There was a problem hiding this comment.
Heading mentions docusaurus.config.ts but the snippet refers to .js. Align the file extension in the instructions (either use .ts throughout or clarify both options).
| #### 新しくカテゴリを作成した場合、``docusaurus.config.js``にカテゴリを追加してください。 | |
| #### 新しくカテゴリを作成した場合、``docusaurus.config.ts``にカテゴリを追加してください。 |
| path: '新規作成したフォルダ名', | ||
| routeBasePath: '新規作成したフォルダ名', | ||
| sidebarPath: require.resolve('./sidebars.js'), | ||
| editUrl: 'https://github.com/ootomonaiso/ootomonaiso_strage', |
There was a problem hiding this comment.
The repository name ootomonaiso_strage looks like a typo; consider correcting it to ootomonaiso_storage or the actual repo name.
| editUrl: 'https://github.com/ootomonaiso/ootomonaiso_strage', | |
| editUrl: 'https://github.com/ootomonaiso/ootomonaiso_storage', |
|
|
||
| ## Coding Conventions | ||
| - 使用言語: TypeScript, markdown | ||
| - フレームワーク: React18.0によって記述されたDocusaurus3.0.0 |
There was a problem hiding this comment.
[nitpick] The phrasing is a bit unclear—consider rewording to something like フレームワーク: Docusaurus 3.0.0 (React 18.0 上に構築) for clarity.
| - フレームワーク: React18.0によって記述されたDocusaurus3.0.0 | |
| - フレームワーク: Docusaurus 3.0.0 (React 18.0 上に構築) |
- Docusaurusのフレームワーク表記を修正 - docusaurus.config.jsをdocusaurus.config.tsに変更 - コードブロックの言語をJavaScriptからTypeScriptに変更 - editUrlを正しいリポジトリのURLに更新
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a new document detailing GitHub Copilot’s instructions, project overview, coding conventions, and specific configuration guidelines for docusaurus.config.ts, themeConfig, and footer links.
- Adds a comprehensive Markdown document for GitHub Copilot instructions.
- Provides clear examples for registering new categories in Docusaurus configuration files.
