🎉 Docs アプリを追加

[tatsutakein]

Issue

• close #ISSUE_NUMBER 🦕

概要

Docs アプリを追加します.

レビュー観点

特になし

レビューレベル

• Lv0: まったく見ないで Approve する
• Lv1: ぱっとみて違和感がないかチェックして Approve する
• Lv2: 仕様レベルまで理解して、仕様通りに動くかある程度検証して Approve する
• Lv3: 実際に環境で動作確認したうえで Approve する

レビュー優先度

• すぐに見てもらいたい ( hotfix など ) 🚀
• 今日中に見てもらいたい 🚗
• 今日〜明日中で見てもらいたい 🚶
• 数日以内で見てもらいたい 🐢

参考リンク

• https://starlight.astro.build/ja/

スクリーンショット

Before	After

Summary by CodeRabbit

• 新機能

  • ドキュメントのビルドとCloudflare Pagesへの公開を行う新しいGitHub Actionsワークフローを追加しました。
  • ドキュメントサイトのパフォーマンスチェックにLighthouseを導入しました。

• ドキュメンテーション

  • Starlight Starter Kitの基本情報を含むREADME.mdを更新しました。
  • ガイドとリファレンスページを追加し、ユーザーが特定のタスクを実行する手順を案内します。

• その他

  • ドキュメントプロジェクトの.gitignoreを設定し、ビルド出力や依存関係などの追跡を除外しました。
  • Astroウェブサイトの設定を定義し、NITO Docsウェブサイト向けにタイトルやナビゲーションをカスタマイズしました。

[coderabbitai]

Walkthrough

ドキュメンテーションのビルドとパフォーマンスチェックのために、GitHubのワークフローにdocsジョブが追加されました。この変更は、Ubuntu 22.04を実行環境とし、ドキュメントに関連する変更がある場合にトリガーされます。新しい設定には、リポジトリのチェックアウト、GitHubアプリトークンの生成、Bunのセットアップ、依存関係のインストールとキャッシュ、Cloudflare Pagesへの公開、そしてLighthouseによるパフォーマンスチェックが含まれています。

Changes

ファイルパス	変更概要
.github/workflows/.../checks.yml	docsジョブを追加し、ドキュメントが変更された場合に実行されるように設定。
.github/workflows/.../development.yml	docsジョブを追加し、ドキュメントのビルドとCloudflare Pagesへの公開、Lighthouseによるパフォーマンスチェックを実施。
.github/workflows/.../preview.yml	docsジョブを追加し、ドキュメントのビルドとCloudflare Pagesへの公開、Lighthouseチェックを実施。
.github/workflows/.../production.yml	docsジョブを追加し、ドキュメントのビルドとCloudflare Pagesへの公開、Lighthouseチェックを実施。
apps/docs/.gitignore	Gitが追跡しないファイルとディレクトリのルールを提供。
apps/docs/README.md	Starlight Starter Kitの概要を説明。
apps/docs/astro.config.mjs	Astroウェブサイトの設定を導入し、NITO Docsのタイトルやソーシャルリンク、サイドバーナビゲーションをカスタマイズ。
apps/docs/src/content/config.ts	astro:contentモジュールを使用してコレクションを定義する機能を導入。
apps/docs/src/content/docs/.../example.md	ユーザーガイドを提供し、特定のタスクを順を追って説明。
apps/docs/src/content/docs/index.mdx	NITOのウェルカムページを提供し、Starlightを使用したドキュメントサイトの構築に関するガイダンスを提供。
apps/docs/src/content/docs/.../example.md	Starlightドキュメントサイトのリファレンスページを提供し、ドキュメントの内容を簡潔に概要説明。
apps/docs/src/env.d.ts	Astroとそのクライアントの型定義を参照。

🐇💭
文書の海に灯台建てたり
コードの森を照らす光
ページめくるごとに新世界
バグなき明日へ、ぴょんと跳ねる

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit-tests for this file.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit tests for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[nito-bot]

Device	URL
mobile	https://e91a959e.nito-docs.pages.dev

Not what you expected? Are your scores flaky? GitHub runners could be the cause.
Try running on Foo instead

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 7018d0e and 7b89820.

Files ignored due to filter (3)

• apps/docs/package.json
• apps/docs/public/favicon.svg
• apps/docs/tsconfig.json

Files selected for processing (12)

• .github/workflows/checks.yml (1 hunks)
• .github/workflows/development.yml (1 hunks)
• .github/workflows/preview.yml (1 hunks)
• .github/workflows/production.yml (1 hunks)
• apps/docs/.gitignore (1 hunks)
• apps/docs/README.md (1 hunks)
• apps/docs/astro.config.mjs (1 hunks)
• apps/docs/src/content/config.ts (1 hunks)
• apps/docs/src/content/docs/guides/example.md (1 hunks)
• apps/docs/src/content/docs/index.mdx (1 hunks)
• apps/docs/src/content/docs/reference/example.md (1 hunks)
• apps/docs/src/env.d.ts (1 hunks)

Files skipped from review due to trivial changes (4)

• apps/docs/.gitignore
• apps/docs/README.md
• apps/docs/src/content/docs/guides/example.md
• apps/docs/src/content/docs/reference/example.md

Additional comments: 8

apps/docs/src/env.d.ts (1)

• 1-2: env.d.tsファイルに.astro/types.d.tsとastro/clientの型定義への参照が含まれています。これらの参照がプロジェクトにとって正しいかどうかを確認してください。また、これらの型定義が必要であることを確認してください。

apps/docs/src/content/config.ts (1)

• 1-7: config.tsファイルでは、astro:contentからdefineCollectionをインポートし、@astrojs/starlight/schemaからdocsSchemaとi18nSchemaをインポートしています。これらのスキーマを使用してdocsとi18nの2つのコレクションを定義しています。これらの使用がプロジェクトのドキュメント構造と一致していることを確認してください。

apps/docs/astro.config.mjs (1)

• 1-27: astro.config.mjsファイルでは、astro/configからdefineConfigをインポートし、@astrojs/starlightからstarlightをインポートしています。starlightプラグインはタイトル、ソーシャルリンク、サイドバーナビゲーションで構成されています。この設定がDocsアプリのプロジェクト要件と一致していることを確認してください。

apps/docs/src/content/docs/index.mdx (1)

• 1-35: index.mdxファイルには、Docsアプリのメインページのメタデータとコンテンツが含まれています。フロントマターはページのタイトル、説明、テンプレート、ヒーローセクション、アクションを定義しています。コンテンツには、@astrojs/starlight/componentsからのCardGridとCardコンポーネントを使用した次のステップの指示が含まれています。このコンテンツがDocsアプリのメインページに適していること、およびコンポーネントが正しく使用されていることを確認してください。

.github/workflows/checks.yml (1)

• 58-75: checks.ymlワークフローファイルに新しいジョブdocsが追加されています。このジョブはubuntu-22.04で実行され、コードをチェックアウトし、Bunをセットアップし、キャッシュを使用して依存関係をインストールし、プロジェクトをビルドします。ジョブの設定が正しいこと、およびステップがDocsアプリに適していることを確認してください。

.github/workflows/production.yml (1)

• 87-132: production.ymlワークフローファイルに新しいジョブdocsが追加されています。このジョブはubuntu-22.04で実行され、コードをチェックアウトし、GitHubアプリトークンを作成し、Bunをセットアップし、キャッシュを使用して依存関係をインストールし、プロジェクトをビルドし、Cloudflare Pagesに公開し、Lighthouseチェックを実行します。ジョブの設定が正しいこと、特にCloudflare Pagesへの公開とLighthouseチェックがDocsアプリに適していることを確認してください。

.github/workflows/development.yml (1)

• 88-133: development.ymlワークフローファイルに新しいジョブdocsが追加されています。このジョブはubuntu-22.04で実行され、リポジトリをチェックアウトし、GitHubアプリトークンを作成し、Bunをセットアップし、キャッシュを使用して依存関係をインストールし、プロジェクトをビルドし、Cloudflare Pagesに公開し、パフォーマンスチェックのためにLighthouseを実行します。ジョブの設定が正しいこと、特にCloudflare Pagesへの公開とLighthouseチェックがDocsアプリに適していることを確認してください。

.github/workflows/preview.yml (1)

• 89-136: preview.ymlワークフローファイルに新しいジョブdocsが追加されています。このジョブはubuntu-22.04で実行され、コードをチェックアウトし、GitHubアプリトークンを作成し、Bunをセットアップし、キャッシュを使用して依存関係をインストールし、プロジェクトをビルドし、Cloudflare Pagesに公開し、PRコメントが有効なLighthouseチェックを実行します。ジョブの設定が正しいこと、特にCloudflare Pagesへの公開とPRコメント付きのLighthouseチェックがDocsアプリに適していることを確認してください。