Skip to content

Add Japanese BEAR Examples CMS source index#364

Draft
koriym wants to merge 1 commit into
bearsunday:masterfrom
koriym:codex/bear-examples-cms-source-index-ja
Draft

Add Japanese BEAR Examples CMS source index#364
koriym wants to merge 1 commit into
bearsunday:masterfrom
koriym:codex/bear-examples-cms-source-index-ja

Conversation

@koriym
Copy link
Copy Markdown
Member

@koriym koriym commented May 27, 2026

Summary

  • Add a Japanese BEAR.Examples CMS source index page for AI and human lookup
  • Link the new index from llms.txt so AI agents can discover it
  • Keep the sidebar and existing examples page unchanged for this PR

Notes

The new page assumes the future BEAR.Examples/cms layout and BEAR\\Examples\\Cms namespace. It intentionally uses source-path references instead of external GitHub URLs while that repository move is still pending.

Included sample cards

Data access / BDR

  • db-read-one-entity — DBから主キーで1件のEntityを読む
  • db-read-by-natural-key — natural keyで1件読む
  • db-read-list-pager — DBから一覧をページングして読む
  • db-command-write — DB書き込みをCommand Interfaceに分ける
  • db-link-table-sync — link tableをclear/linkで同期する
  • db-result-projection — Query結果を専用Result objectにする
  • db-array-row-comparison — Entityではなくarrayで読む比較例を見る
  • db-sqlquery-orchestrationSqlQueryInterfaceで複数SQLを調停する
  • db-raw-pdo-comparison — Raw PDOとの違いを見る

Resource / API

  • api-get-hal-resource — GET ResourceをHAL+JSONで返す
  • api-post-input-dto — POST入力をInput DTOで受ける
  • api-put-tristate-input — PUTでtri-state入力を扱う
  • api-delete-no-content — DELETE成功を204で返す
  • not-found-response — 見つからないResourceを404にする
  • json-schema-validation — Request/ResponseをJSON Schemaで検証する
  • hal-link — HAL _links#[Link] で宣言する
  • hal-embed — HAL _embedded#[Embed]addQuery() で作る

HTML / Page

  • page-resource-qiq-detail — Page Resourceで1件詳細HTMLを描画する
  • page-resource-list — Page Resourceで一覧HTMLを描画する
  • markdown-to-html — Markdown本文をHTMLへ変換する
  • admin-prg-form — Admin formでPRGを使う

Runtime / representation

  • stream-response — ファイルやバイナリをストリームで返す
  • cacheable-leaf#[Cacheable] だけのleaf resourceを作る
  • cache-embed-dependency#[Embed] 親Resourceの依存を自動合成する
  • cache-body-derived-dependency — body由来の可変長依存を fromAssoc() で宣言する
  • async-embed-parallel — embed graphを並列実行に載せる
  • cli-resource — ResourceをCLIコマンドとして公開する

Tests / fake

  • fake-sql-query — DBなしでMediaQueryをFakeする
  • app-resource-test — App ResourceのAPI contractをテストする
  • page-resource-test — Page ResourceのHTML contractをテストする
  • hypermedia-workflow-test — Link/Embedを辿るworkflowをテストする
  • mysql-integration-test — 実DB経路を必要時だけ検証する

Semantic / generated artifacts

  • alps-profile-ssot — ALPS profileを意味のSSOTにする
  • semantic-fake-data — semantic-exで決定的fake dataを作る
  • json-schema-generated — fake observationからJSON Schemaを生成する
  • apidoc-llms-generated — API docsとllms.txtを生成する

Validation

  • php bin/gen_llms.php
  • bundle exec jekyll build with rbenv Ruby 3.2.2
  • Confirmed _site/manuals/1.0/ja/bear-examples-cms-source-index.html is generated
  • Confirmed generated llms-full.txt includes the new source index content

Summary by CodeRabbit

リリースノート

  • Documentation
    • 新しい日本語ドキュメント「BEAR.Examples CMS ソース索引」を追加しました。Data access、Resource、HTML、Runtime、Tests、Semanticの6つの領域で、実装やテストの参照先を整理し、検索効率を向上させます。

Review Change Stack

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 28, 2026

Walkthrough

新しい日本語ドキュメント「BEAR.Examples CMS ソース索引」を manuals/1.0/ja/bear-examples-cms-source-index.md として追加。Data access、API、HTML/Page、Runtime、テスト、セマンティック生成の6領域を網羅し、各実装パターンの参照先とテストを一覧化。llms.txt に該当ドキュメントへのリンクを登録。

Changes

BEAR.Examples CMS 索引ドキュメント追加

Layer / File(s) Summary
BEAR.Examples CMS 索引ドキュメント本体
manuals/1.0/ja/bear-examples-cms-source-index.md
新しい日本語ドキュメント。フロントマター・導入部に続き、Data access/BDR(DB読取り・書込み・同期パターン)、Resource/API(HAL+JSON・検証・404)、HTML/Page(描画・Markdown変換)、Runtime/representation(キャッシュ・埋め込み・CLI)、Tests/fake(Fake実装・契約テスト)、Semantic/generated artifacts(ALPS・schema生成)の6領域を、Status・参照先・テスト・Key points付きで列挙。
llms.txt への登録
llms.txt
リンク一覧に「BEAR.Examples CMS Source Index (Japanese)」エントリを追加し、新規ドキュメントを参照。

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

Suggested reviewers

  • NaokiTsuchiya
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed プルリクエストのタイトル「Add Japanese BEAR Examples CMS source index」は、変更内容の主要な点を正確に反映しています。新しい日本語ドキュメント「BEAR.Examples CMS ソース索引」の追加とllms.txtへのリンク掲載という主な変更を明確に示しており、簡潔で具体的です。
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@manuals/1.0/ja/bear-examples-cms-source-index.md`:
- Line 52: 見出しテキスト「### `db-read-by-natural-key` — natural
keyで1件読む」を自然な日本語に直してください(例: 「### `db-read-by-natural-key` — natural
keyで1件を読む」);該当箇所は見出し行内の文字列なので、ハイフン以降の説明文を「natural keyで1件を読む」に変更して可読性を向上させてください。
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 2cfa3a2f-1a56-448d-a895-5ecbd0e966bb

📥 Commits

Reviewing files that changed from the base of the PR and between 422ec9d and 736273f.

📒 Files selected for processing (2)
  • llms.txt
  • manuals/1.0/ja/bear-examples-cms-source-index.md

- **Key points:** `item(int $id): Article|null`、SQLファイルは `article_item.sql`、ResourceはSQLを直接持たない。
- **Do not:** Resource内にSQLを書く。templateからDBを読む。

### `db-read-by-natural-key` — natural keyで1件読む
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

見出しの日本語を自然な形に修正してください。

natural keyで1件読むnatural keyで1件を読む のほうが自然です。見出しなので可読性のために直しておくのがよいです。

✏️ 修正案
-### `db-read-by-natural-key` — natural keyで1件読む
+### `db-read-by-natural-key` — natural keyで1件を読む
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
### `db-read-by-natural-key` — natural keyで1件読む
### `db-read-by-natural-key` — natural keyで1件を読む
🧰 Tools
🪛 LanguageTool

[uncategorized] ~52-~52: 文法ミスがあります。"を読む"の間違いです。
Context: ...## db-read-by-natural-key — natural keyで1件読む - ID: db-read-by-natural-key ...

(MEISI_YOMU)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@manuals/1.0/ja/bear-examples-cms-source-index.md` at line 52, 見出しテキスト「###
`db-read-by-natural-key` — natural keyで1件読む」を自然な日本語に直してください(例: 「###
`db-read-by-natural-key` — natural
keyで1件を読む」);該当箇所は見出し行内の文字列なので、ハイフン以降の説明文を「natural keyで1件を読む」に変更して可読性を向上させてください。

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.

1 participant