Knowledge Bundle
Bundle OKF 0.1 · 6 conceitos · hanamizuno/pnpm-biome-astro-panda-ark-template
Open source Repository Open in the app JSON README (API)
About
# Knowledge Bundle
このディレクトリは [Open Knowledge Format (OKF) v0.1](https://github.com/GoogleCloudPlatform/knowledge-catalog/blob/main/okf/SPEC.md) に準拠した知識バンドルです。AI エージェントと人間の双方が、プレーンな Markdown として読み書きできる共有メモリとして運用します。
このテンプレートでは **スケルトンのみ** を同梱します。ディレクトリ構成と予約ファイル (`index.md` / `log.md`)、そして「サブディレクトリごとに 1 つだけ」の見本ドキュメントを置いてあります。プロジェクトが育つにつれて、サンプルは実コンテンツで上書きしてください。プレースホルダを溜め込まないようにしましょう。
ユーザー向けのドキュメント (`README.md`) や AI エージェント向けのガイドライン (`AGENTS.md`) とは異なり、このバンドルは **コードや git 履歴からは読み取りにくい意思決定・背景・運用知見** を蓄積するための場所です。コードベースや `git log` から復元できる情報は書かないでください。
## レイアウト
* [architecture/](architecture/) — システム構造・データフロー・段階的なビルド計画
* [adr/](adr/) — Architecture Decision Records (決定とその理由)
* [conventions/](conventions/) — テスト・エラーハンドリング等のリポジトリ横断の取り決め
* [runbooks/](runbooks/) — 障害対応や定型運用の手順
* [research/](research/) — 調査・比較検討のスナップショット
* [log.md](log.md) — バンドル全体の更新ログ
## OKF 運用ルール
* `index.md` と `log.md` は予約ファイル名です。概念ドキュメントとして使ってはいけません。
* バンドルルートの `index.md` のみ `okf_version` フロントマターを持てます。
* それ以外の `.md` フ
Details
- Kind
- OKF bundles
- Topic
- Version control
- Publisher
- hanamizuno
- Origin
- okf_github
- Category
- dados
- Version
- 0.1
- Open pull requests
- 3
- Last push
- 2026-08-14T17:46:37Z
- Repository state
- ativo
- Language
- Shell
- License
- MIT
- Added
- 2026-09-09 12:02:17
- Updated
- 2026-09-09 12:02:17
- Origin id
hanamizuno/pnpm-biome-astro-panda-ark-template:docs/knowledge/index.md
README
# pnpm + Biome + Astro + Panda CSS + Ark UI Template [pnpm](https://pnpm.io/) + [Biome](https://biomejs.dev/) + [Astro](https://astro.build/) + [Panda CSS](https://panda-css.com/) + [Ark UI](https://ark-ui.com/) のテンプレートです。 ## 機能一覧 - Astro 7 による静的サイト生成（MDX / Content Collections / sitemap / RSS / robots.txt） - Panda CSS 1.10 による型安全なスタイリング（セマンティックトークン + light/dark テーマ） - Ark UI 5 + React 19 の Astro Islands（テーマメニューのサンプル付き） - TypeScript による型安全な開発環境（Astro strict プリセット） - Biome 2 による高速なフォーマット・リント（TS/TSX/JSON/JSONC を担当。`.astro` は Astro VS Code 拡張） - テスト・ベンチマーク・カバレッジ計測（vitest, しきい値 80%、計測対象は `src/utils/**`） - pre-commit hooks による品質保証（biome / astro check / secretlint） - GitHub Actions による CI（Node 24/25 マトリクス、Actions は commit SHA・Dev Container Features と Docker ベースイメージは sha256 digest で固定、依存自動更新） - PR 自動ラベリング（actions/labeler — ハーネス変更 PR に `meta` ラベル）とラベル定義の同期（`.github/labels.yml`） - セキュリティスキャン（secretlint / pnpm audit / Trivy — push・cron 時は SARIF を Security タブへ集約） - SBOM 生成（CycloneDX、cdxgen） - Dockerfile / GitHub Actions 自体のリント（hadolint / actionlint / zizmor） - `docs/knowledge/` — OKF v0.1 準拠の知識バンドル（ADR / アーキテクチャ / 取り決め / runbook / 調査のスケルトン） - VS Code Dev Containers: AI エージェントツールチェーン（Claude Code CLI、Codex CLI、GitHub CLI、共通ユーティリティ）を [Dev Container Features](https://containers.dev/implementors/features/) と post-create セットアップで重ねて注入 - Chrome DevTools MCP + headless Chromium: エージェントがコンテナ内で画面の見た目をデバッグ（スクリーンショット・コンソール・ネットワーク確認） ## セットアップ ```bash corepack enable pnpm install ``` `pnpm install` の `prepare` ライフサイクルで `panda codegen` が自動実行され、 `styled-system/` ディレクトリが生成されます。 `pnpm` は `package.json` の `packageManager` フィールド経由で corepack が自動的に正しいバージョンを使用します。 ### pre-commit hooks（任意） [prek](https://github.com/j178/prek) を[インストール](https://github.com/j178/prek?tab=readme-ov-file#installation)した後： ```bash prek install ``` ## 主なコマンド ```bash pnpm dev # Astro 開発サーバー（http://localhost:4321） pnpm build # Astro で dist/ にビルド pnpm preview # dist/ をローカル配信 pnpm studio # Panda Studio（http://localhost:3000） pnpm check # astro check（型 + 構文） pnpm test # vitest 単体テスト pnpm test:cov # カバレッジ計測 pnpm bench # ベンチマーク pnpm fmt # フォーマット適用 pnpm fmt:check # フォーマット検査のみ pnpm lint # Biome リント pnpm release-check # CI 相当（biome ci + astro check + vitest + astro build） pnpm scan:secrets # シークレット検出 pnpm prepare # panda codegen 手動実行（panda.config.ts 変更後など） ``` 詳細は [AGENTS.md](AGENTS.md) を参照。 ## 初期設定でやっておくこと 派生プロジェクトを作ったら、以下を自分の値に置換してください。 1. `astro.config.mjs` の `site: "https://example.com"` を公開 URL に変更 2. `src/config.ts` の `SITE` メタデータ（title / description / author 等）を編集 3. `public/favicon.svg` を自身の favicon に差し替え 4. `LICENSE` 内の `[yyyy] [name of copyright owner]` を年と著作権者名に置換 5. `.github/CODEOWNERS` の `@REPLACE-ME` を実在の GitHub ハンドルに置換 6. `package.json` の `name` を派生先のパッケージ名に変更 7. `docs/knowledge/` のサンプルドキュメントを実プロジェクトの知識で差し替え（運用ルールは `docs/knowledge/index.md` を参照） 8. `corepack enable && pnpm install && pnpm release-check` を実行し、セットアップ後のプロジェクトが健全なことを確認（install の `prepare` で `panda codegen` が走ります） ## プロジェクト構造 ディレクトリ構成・設定ファイルの詳細は [AGENTS.md](AGENTS.md) を参照してください。 ## AI Agent Dev Container VS Code Dev Container を AI コーディングエージェント（Claude Code / Codex 等）の実行環境としても利用できます。同梱ツール・認証手順・ホスト設定の継承・サンドボックスのモード・PAT 運用などの詳細は [.devcontainer/README.md](.devcontainer/README.md) を参照してください。 ## リリースチェックリスト 1. `pnpm release-check` を実行してすべてのチェックが通ることを確認 2. `CHANGELOG.md` を更新 3. バージョンタグを作成 ## ライセンス [MIT](LICENSE)。`LICENSE` 内の `[yyyy] [name of copyright owner]` は派生先で年と著作権者名に置換してください。