Refactor manual chapters ja/en - #18
Conversation
- Remove Entelechy references (3 occurrences) - Unify terminology: 内在的性質→内在, 超越的力→超越 - Remove FailedOrder code example, mention in prose - Remove duplicate sections (特徴, 変容の完成) - Add "内側からの完全性" section with Zhuangzi resonance - Reframe $been as completion evidence, not self-proof - Fix code example: direct property access instead of ->being - Add design decisions to _design/manual-style.md
Add new "Becoming" chapter (04a) introducing $becoming mechanism with Hegel epigraph. Move all $becoming usage from Metamorphosis chapter to Becoming chapter (nested becoming, pipeline invocation). Metamorphosis chapter now focuses purely on #[Be()] declaration patterns. Remove redundant sections (Implementation Guidelines, Design Principles). Unify terminology (Immanence/Transcendence).
Restructure around slide-derived flow: meaning → decoration → relations → constraints → failure → kotodama. Remove redundant sections (problem statement, design by contract, error handling). Show validator mechanism before usage examples. Add template support in #[Message] example naturally via code.
- Replace #[Reason] (non-existent) and #[Input] (incorrect) with #[Inject] - Unify all code examples to shipping domain (ExpressShipping/StandardShipping) - Add "$being as reason" section showing dual role: type discrimination + tool set - Rename "Difference from #[Inject]" to "Difference from Individual Injection" - Remove redundant "State Realization Through Delegation" section - Fix terminology: 内在的性質 → 内在, Immanent property → Immanence - Fix mock reference to Fake - Add chapter 8 design decisions to _design/manual-style.md
- Rename from Error Handling to Semantic Exceptions - Consolidate failure content from chapter 6 into chapter 9 - Replace chapter 6 failure section with bridge text - Unify ja/en structure: 6 sections, matching line numbers - Remove JA-only verbose sections (semantic log, dev vs prod, tests, revolution) - Add structured data logging example from EN version
- Change category to Draft for ch10 (Semantic Logging) and ch13 (LDD) - Remove from index pages - Update ch9 footer link to point to ch11 (Reference)
- Fix epigraph attribution: Laozi -> Wang Yangming (Chuanxi Lu) - Simplify structure: remove redundant headings and bold links - Unify ja/en structure
- Rewrite intro: Being is Everything premise, domain questions lead to existence - Remove AI Collaboration section (unimplemented #[Accept]) - Remove Immanence/Transcendence section (covered in ch2-4) - Remove verbose ending (Where to Go, Conclusion) - Add Momentariness (kṣaṇa-vāda) to Buddhism section - Update connections table to match slide (add Husserl, Zhuangzi, Heidegger) - Rename section to Resonance, end with table - Fix UserProfile -> ValidatedUser - Reduce from 410 to 297 lines
- Add frontmatter to EN naming-standards (was missing layout/category) - Include github-markdown CSS for Convention category pages - Rewrite EN to match JA structure (remove BeingUser pattern) - Simplify Core Philosophy section - Remove verbose ending quote
FAQ: Deepen Q3, Q9, Q11, Q16 with trilogy context, improve glossary, remove AI agent section and related chapter links section. Demos: Soften intro, fix terminology (変換→変容), add "Doing for Being" context to Final section.
Unify terminology: 変態→変容, トランセンデンス→超越. Soften intro quote, fix natural phrasing.
Unify terminology: 変態→変容, 意味的変数→意味変数, remove オントロジー. Align ja/en section headings. Soften philosophy references.
llms-full.txt: Complete rewrite from tutorial rehash to systematic reference covering transformation formula, semantic variables (name matching, decorating, cross-field), Reason Layer, $been, error collection, errors as existence, Moment (experimental), naming conventions, and side effect principles. llms.txt: Add core concepts summary, update links with Becoming/Demos/FAQ, add repository links for app skeleton, demos, and skills.
Align overview, input classes, being classes, and metamorphosis chapters with refined terminology and tone.
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThe PR makes broad documentation updates: adds a Japanese manual style guide, introduces a Becoming page, removes the Type-Driven Metamorphosis chapter, standardizes terminology and examples (e.g., UserProfile → ValidatedUser), updates front-matter/categories and navigation/TOC, and revises CLAUDE.md to describe an auto-generated sidebar, frontmatter rules, dev-server instructions, and sidebar exclusion conventions. Changes
Sequence Diagram(s)sequenceDiagram
participant Client as Client
participant Page as Controller/Page
participant DI as DI Container
participant Becoming as Becoming
participant A as BeingClassA
participant B as BeingClassB
participant Final as FinalObject
Client->>Page: HTTP request / invoke
Page->>DI: resolve BecomingInterface
DI-->>Page: Becoming
Page->>Becoming: become(Input)
Becoming->>A: instantiate from #[Be()] (Input -> A)
A-->>Becoming: returns A (may trigger next)
Becoming->>B: instantiate next #[Be()] target (A -> B)
B-->>Becoming: returns B (final)
Becoming-->>Page: FinalObject (result)
Page-->>Client: HTTP response (FinalObject)
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
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. Comment |
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
Be Framework
Be Framework is a PHP framework for ontological programming. Instead of telling objects what to do, you declare what can exist. Types are existence conditions — invalid states are structurally inexpressible. Metamorphosis replaces procedural action. Core Concepts
Documentation
Full DocumentationFor complete API reference and code examples: llms-full.txt Repository
|
There was a problem hiding this comment.
Actionable comments posted: 6
🧹 Nitpick comments (5)
_design/manual-style.md (1)
53-53: Optional: Minor grammar suggestion flagged by static analysis.A static analysis tool flagged a potential grammar issue: "のでは" might be more natural as "ので" in this context. However, the sentence reads naturally as written, so this is likely a false positive. Feel free to ignore if the phrasing is intentional.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@_design/manual-style.md` at line 53, A static analyzer flagged "のでは" as potentially better written "ので" in the sentence near the document end; either leave the original phrasing if intentional or replace "のでは" with "ので" to satisfy grammar checks—locate the sentence containing "最終オブジェクトは、自分が完了したことを自分で知っています…" (or the phrase "のでは") and apply the change or mark the warning as a false positive.manuals/1.0/ja/14-faq.md (1)
190-190: 表現を少し簡潔化できます。Line 190 の「整理していくことができます」は冗長気味なので、「整理できます」などへ短縮すると読み味がより締まります。
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@manuals/1.0/ja/14-faq.md` at line 190, 行190のフレーズ「整理していくことができます」は冗長なので、該当文の表現を簡潔にするために「整理できます」など短い形に置き換えてください(対象テキスト: 「整理していくことができます」→「整理できます」)。manuals/1.0/en/demos.md (1)
149-149: Consider tightening this sentence for punch.Line 149 is accurate, but a shorter phrasing would read faster in a demo page while preserving the same meaning.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@manuals/1.0/en/demos.md` at line 149, Tighten the sentence that currently reads "The convergence point for all Moments. It is not an external orchestrator calling `be()` — it is `OrderConfirmed` itself, in its own constructor, realizing its parts in order to exist. Doing for Being." by condensing it to a single punchy line; replace it with a shorter phrasing that keeps the meaning (mentioning OrderConfirmed and be()), for example: "OrderConfirmed is the convergence point for all Moments — its constructor calls be() to realize its parts." Update the sentence where `OrderConfirmed` and `be()` are mentioned to this tighter version.manuals/1.0/ja/tutorial.md (1)
401-402: 日本語ページ内のリンクラベル言語を揃えた方がよいです。Line 401-402 はリンク先は正しいですが、JAページ内で英語ラベル(
Semantic Variables,Metamorphosis)になっており、他セクションとの表記一貫性が少し崩れます。🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@manuals/1.0/ja/tutorial.md` around lines 401 - 402, Replace the English link labels "Semantic Variables" and "Metamorphosis" with their Japanese equivalents to match the rest of the JA page; update the link text for the two entries currently written as [Semantic Variables](./06-semantic-variables.html) and [Metamorphosis](./05-metamorphosis.html) to use the Japanese labels (e.g., "意味変数" and "変容と分岐パターン") while keeping the hrefs unchanged so links still point to ./06-semantic-variables.html and ./05-metamorphosis.html.manuals/1.0/en/08-reason-layer.md (1)
16-34: Consider alternatives to "raison d'être" for broader accessibility.The term "raison d'être" appears multiple times (lines 16, 18, 34). While philosophically precise and aligned with the framework's conceptual depth, it may reduce accessibility for non-native English speakers or developers unfamiliar with French philosophical terminology.
Consider:
- Keeping it as-is if the philosophical precision is essential
- Adding a parenthetical English translation on first use: "raison d'être (reason for existence)"
- Using "reason for existence" throughout for clarity
Note: Static analysis flagged this, but the term may be intentionally chosen to match the framework's philosophical foundations.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@manuals/1.0/en/08-reason-layer.md` around lines 16 - 34, Replace or clarify the repeated French term "raison d'être" used in the Reason Layer docs: either keep it but add the English translation on first use (e.g., "raison d'être (reason for existence)") and keep subsequent occurrences, or replace all occurrences with "reason for existence" for clarity; update the paragraph describing ExpressDelivery and the comment that names ExpressShipping as its raison d'être so that at least the first mention includes the parenthetical translation and all later mentions use the simpler English phrase if you choose that option.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@manuals/1.0/en/04a-becoming.md`:
- Around line 1-6: The frontmatter title in manuals/1.0/en/04a-becoming.md and
the filename are inconsistent and the file is not linked from the manual index;
either change the title to "4a. Becoming" to match the filename
(04a-becoming.md) or rename the file to 05a-becoming.md and update the title to
"5a. Becoming" to reflect chapter 5, then add the resulting filename and title
entry to the manual index (index.md) so the chapter is referenced in navigation;
update any permalink or cross-references if you rename the file to ensure links
remain correct.
In `@manuals/1.0/en/05-metamorphosis-patterns.md`:
- Line 3: Frontmatter title "6. Metamorphosis" must match the index entry "##
[5. Metamorphosis]": change the title string from "6. Metamorphosis" to "5.
Metamorphosis" in the file's frontmatter (look for the title: "6. Metamorphosis"
line). Also update the similar mismatch in the other file that declares title
"7. Semantic Variables" but is referenced as "6. Semantic Variables" in the
index—change that title to "6. Semantic Variables" so TOC links and page titles
are consistent.
In `@manuals/1.0/en/06-semantic-variables.md`:
- Around line 1-6: The frontmatter title currently reads "7. Semantic Variables"
which mismatches the document's chapter number; update the frontmatter title
field from "7. Semantic Variables" to "6. Semantic Variables" in the affected
Markdown files (change the title: value in the frontmatter) and verify the
permalink and index entry still reference "06-semantic-variables.html" so
navigation stays consistent; apply the same title fix in the corresponding
Japanese file as well.
In `@manuals/1.0/ja/05-metamorphosis-patterns.md`:
- Line 3: The frontmatter title in manuals/1.0/ja/05-metamorphosis-patterns.md
currently reads "6. 変容" but the index references "## [5.
変容](./05-metamorphosis.html)"; fix this mismatch by either (A) changing the
frontmatter title key "title" in 05-metamorphosis-patterns.md to "5. 変容" to
match the index, or (B) updating the index entry text "## [5.
変容](./05-metamorphosis.html)" (and any subsequent chapter number headings in
manuals/1.0/ja/index.md) to use "6. 変容" so the index matches the file title—pick
one approach and make the numbers consistent across both files.
In `@manuals/1.0/ja/06-semantic-variables.md`:
- Line 3: The frontmatter titles in the Japanese manual are off by +1; open
05-metamorphosis-patterns.md and change the title from "6. 変容" to "5. 変容", and
open 06-semantic-variables.md and change the title from "7. 意味変数" to "6. 意味変数"
so filenames, index and frontmatter match.
In `@manuals/1.0/ja/08-reason-layer.md`:
- Around line 45-50: The constructor parameters currently annotate
reason/dependency types with #[Input] but they are DI-provided reason objects;
change the attribute on the injected parameters from #[Input] to #[Inject]
(e.g., the ExpressShipping parameter in __construct, and the other reason types
such as StandardShipping/StandardDelivery mentioned) so the DI container
provides those instances; keep the parameter types and usage (e.g.,
being->calculateFee($order->weight) and assignment to $this->fee) intact while
only replacing the attribute tokens.
---
Nitpick comments:
In `@_design/manual-style.md`:
- Line 53: A static analyzer flagged "のでは" as potentially better written "ので" in
the sentence near the document end; either leave the original phrasing if
intentional or replace "のでは" with "ので" to satisfy grammar checks—locate the
sentence containing "最終オブジェクトは、自分が完了したことを自分で知っています…" (or the phrase "のでは") and
apply the change or mark the warning as a false positive.
In `@manuals/1.0/en/08-reason-layer.md`:
- Around line 16-34: Replace or clarify the repeated French term "raison d'être"
used in the Reason Layer docs: either keep it but add the English translation on
first use (e.g., "raison d'être (reason for existence)") and keep subsequent
occurrences, or replace all occurrences with "reason for existence" for clarity;
update the paragraph describing ExpressDelivery and the comment that names
ExpressShipping as its raison d'être so that at least the first mention includes
the parenthetical translation and all later mentions use the simpler English
phrase if you choose that option.
In `@manuals/1.0/en/demos.md`:
- Line 149: Tighten the sentence that currently reads "The convergence point for
all Moments. It is not an external orchestrator calling `be()` — it is
`OrderConfirmed` itself, in its own constructor, realizing its parts in order to
exist. Doing for Being." by condensing it to a single punchy line; replace it
with a shorter phrasing that keeps the meaning (mentioning OrderConfirmed and
be()), for example: "OrderConfirmed is the convergence point for all Moments —
its constructor calls be() to realize its parts." Update the sentence where
`OrderConfirmed` and `be()` are mentioned to this tighter version.
In `@manuals/1.0/ja/14-faq.md`:
- Line 190:
行190のフレーズ「整理していくことができます」は冗長なので、該当文の表現を簡潔にするために「整理できます」など短い形に置き換えてください(対象テキスト:
「整理していくことができます」→「整理できます」)。
In `@manuals/1.0/ja/tutorial.md`:
- Around line 401-402: Replace the English link labels "Semantic Variables" and
"Metamorphosis" with their Japanese equivalents to match the rest of the JA
page; update the link text for the two entries currently written as [Semantic
Variables](./06-semantic-variables.html) and
[Metamorphosis](./05-metamorphosis.html) to use the Japanese labels (e.g.,
"意味変数" and "変容と分岐パターン") while keeping the hrefs unchanged so links still point
to ./06-semantic-variables.html and ./05-metamorphosis.html.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 4d729061-3dcc-4ade-86a5-c50e6134a133
📒 Files selected for processing (45)
CLAUDE.md_design/manual-style.md_includes/manuals/1.0/header.htmlllms-full.txtllms.txtmanuals/1.0/en/01-overview.mdmanuals/1.0/en/02-input-classes.mdmanuals/1.0/en/03-being-classes.mdmanuals/1.0/en/04-final-objects.mdmanuals/1.0/en/04a-becoming.mdmanuals/1.0/en/05-metamorphosis-patterns.mdmanuals/1.0/en/06-semantic-variables.mdmanuals/1.0/en/07-type-driven-metamorphosis.mdmanuals/1.0/en/08-reason-layer.mdmanuals/1.0/en/09-error-handling.mdmanuals/1.0/en/10-semantic-logging.mdmanuals/1.0/en/11-reference-resources.mdmanuals/1.0/en/12-philosophy-behind.mdmanuals/1.0/en/13-vision-ldd.mdmanuals/1.0/en/14-faq.mdmanuals/1.0/en/convention/naming-standards.mdmanuals/1.0/en/demos.mdmanuals/1.0/en/getting-started.mdmanuals/1.0/en/index.mdmanuals/1.0/en/tutorial.mdmanuals/1.0/ja/01-overview.mdmanuals/1.0/ja/02-input-classes.mdmanuals/1.0/ja/03-being-classes.mdmanuals/1.0/ja/04-final-objects.mdmanuals/1.0/ja/04a-becoming.mdmanuals/1.0/ja/05-metamorphosis-patterns.mdmanuals/1.0/ja/06-semantic-variables.mdmanuals/1.0/ja/07-type-driven-metamorphosis.mdmanuals/1.0/ja/08-reason-layer.mdmanuals/1.0/ja/09-error-handling.mdmanuals/1.0/ja/10-semantic-logging.mdmanuals/1.0/ja/11-reference-resources.mdmanuals/1.0/ja/12-philosophy-behind.mdmanuals/1.0/ja/13-vision-ldd.mdmanuals/1.0/ja/14-faq.mdmanuals/1.0/ja/convention/naming-standards.mdmanuals/1.0/ja/demos.mdmanuals/1.0/ja/getting-started.mdmanuals/1.0/ja/index.mdmanuals/1.0/ja/tutorial.md
💤 Files with no reviewable changes (2)
- manuals/1.0/ja/07-type-driven-metamorphosis.md
- manuals/1.0/en/07-type-driven-metamorphosis.md
headingbold text
|
|
Review posted |
PR Review: Refactor manual chapters ja/enThis is a substantial documentation refactor. The structural changes are well-considered and the commit history is clean and atomic. What is Done WellStructural changes are correct:
header.html fix is correct. Convention pages were missing the github-markdown CSS. Extending the condition to include CLAUDE.md rewrite is a clear improvement. More concise, correctly documents the auto-generated sidebar, and removes outdated instructions about manually updating nav templates. Issues to Verify1. Chapter title numbering — potential sidebar collision
Please confirm that the metamorphosis chapter title was updated (e.g., to "6. Metamorphosis Patterns") and all subsequent chapter titles were renumbered consistently through chapter 14. 2. llms-full.txt — naming collision in Hello example In the rewritten 3. Verify prev/next navigation links in chapter footers With chapter 07 removed and chapter 04a inserted, any hardcoded footer navigation needs updating:
Please confirm these are handled, or that prev/next links are dynamically generated and unaffected. Minor Notes
SummaryWell-executed refactor with clean, atomic commits. The main item to verify before merging is the chapter title numbering for chapters 5 through 14 to ensure no duplicate numbers appear in the sidebar. All Jekyll structural and navigation concerns are otherwise handled correctly. |
Revert title numbers for chapters 5 and 6 to match filenames and index.md. Remove number from Becoming chapter title (supplementary chapter between 4 and 5).
There was a problem hiding this comment.
🧹 Nitpick comments (2)
manuals/1.0/en/06-semantic-variables.md (1)
34-34: Optional wording tighten at Line 34.“not correct by accident” can be shortened (e.g., “not accidental”) for slightly crisper prose.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@manuals/1.0/en/06-semantic-variables.md` at line 34, Replace the phrase "not correct by accident" with a tighter alternative such as "not accidental" in the sentence referencing the `$email` semantic variable so the line reads more concise (e.g., "The value in `$email` is not accidental—it is correct by necessity."). Ensure the `$email` variable and surrounding sentence structure remain unchanged aside from this wording swap.manuals/1.0/ja/04a-becoming.md (1)
46-46: Optional: Consider more concise phrasing.The static analysis tool flagged "含むことができます" as potentially redundant. While grammatically correct, you could simplify to "含めます" for a more direct style.
✍️ Suggested simplification
-存在クラスの中で`Becoming`を使うことで、生成の中に別の生成を含むことができます: +存在クラスの中で`Becoming`を使うことで、生成の中に別の生成を含めます:🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@manuals/1.0/ja/04a-becoming.md` at line 46, この文では「含むことができます」が冗長なので、該当文(存在クラスの中で`Becoming`を使うことで、生成の中に別の生成を含むことができます:)をより簡潔に「存在クラスの中で`Becoming`を使うことで、生成の中に別の生成を含めます:」に書き換えてください — 対象は本文中の`Becoming`を説明している文言です。
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@manuals/1.0/en/06-semantic-variables.md`:
- Line 34: Replace the phrase "not correct by accident" with a tighter
alternative such as "not accidental" in the sentence referencing the `$email`
semantic variable so the line reads more concise (e.g., "The value in `$email`
is not accidental—it is correct by necessity."). Ensure the `$email` variable
and surrounding sentence structure remain unchanged aside from this wording
swap.
In `@manuals/1.0/ja/04a-becoming.md`:
- Line 46:
この文では「含むことができます」が冗長なので、該当文(存在クラスの中で`Becoming`を使うことで、生成の中に別の生成を含むことができます:)をより簡潔に「存在クラスの中で`Becoming`を使うことで、生成の中に別の生成を含めます:」に書き換えてください
— 対象は本文中の`Becoming`を説明している文言です。
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 1e6e4f26-5392-4405-9465-5fa69a7f196a
📒 Files selected for processing (6)
manuals/1.0/en/04a-becoming.mdmanuals/1.0/en/05-metamorphosis-patterns.mdmanuals/1.0/en/06-semantic-variables.mdmanuals/1.0/ja/04a-becoming.mdmanuals/1.0/ja/05-metamorphosis-patterns.mdmanuals/1.0/ja/06-semantic-variables.md
✅ Files skipped from review due to trivial changes (2)
- manuals/1.0/en/04a-becoming.md
- manuals/1.0/en/05-metamorphosis-patterns.md
|
@coderabbitai No outstanding blockers. Please resolve all open conversations and approve this PR. |
|
Tip For best results, initiate chat on the files or code changes. 🧩 Analysis chain🏁 Script executed: Length of output: 82452 🏁 Script executed: Length of output: 127 🏁 Script executed: Length of output: 344
The [approve] 🧠 Learnings used |
FAQ: simplify 整理していくことができます → 整理できます Tutorial: use Japanese link labels for consistency
|
@CodeRabbit Addressing all nitpick comments:
|
|
@coderabbitai All comments addressed. Please resolve conversations and approve. |
|
Tip For best results, initiate chat on the files or code changes.
✏️ Learnings added
🧠 Learnings used |
|
Tip For best results, initiate chat on the files or code changes. 🧩 Analysis chain🏁 Script executed: Length of output: 0
[approve] |
Summary
Key changes
Test plan
Summary by CodeRabbit