Rewrite llms-full.txt as practical LLM reference

[koriym]

Summary

• Rewrite 2423-line tutorial-heavy document as 937-line practical reference
• Add concrete code examples for every binding type, AOP, contextual bindings, multibindings, and performance optimization
• Organize by task for AI code generation use cases

Test plan

• Verify llms-full.txt renders correctly
• Verify code examples are accurate

[sourcery-ai]

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Rewrites llms-full.txt from a long tutorial-style document into a shorter, practical LLM-focused reference with concrete Ray.Di code examples across features, and makes a small wording/diagram tweak in the factory pattern manual to use English runtime/dependency labels.

Sequence diagram for LLM Ray.Di code generation using the rewritten llms_full reference

sequenceDiagram
  actor Developer
  participant LLM
  participant LlmsFullReference
  participant RayDiCodebase

  Developer->>LLM: Request RayDi binding or feature example
  LLM->>LlmsFullReference: Retrieve practical reference section
  LlmsFullReference-->>LLM: Return focused examples and patterns
  LLM->>Developer: Propose RayDi code snippet
  Developer->>RayDiCodebase: Integrate and run generated code
  RayDiCodebase-->>Developer: Execution result and feedback

Loading

Flow diagram for the updated Factory pattern runtime params and DI dependencies illustration

flowchart LR
  RuntimeParams[Runtime params]
  DIDependencies[DI dependencies]
  Factory[Factory]
  ObjectWithDeps[Object with dependencies]

  RuntimeParams --> Factory
  DIDependencies --> Factory
  Factory --> ObjectWithDeps

Loading

File-Level Changes

Change	Details	Files
Convert llms-full.txt into a concise, practical LLM-oriented reference for Ray.Di code generation.	Replaced the previous 2400+ line tutorial-style llms-full.txt with a roughly 900-line, reference-style document optimized for LLM consumption. Documented all binding types, AOP, contextual bindings, multibindings, and performance considerations with concrete Ray.Di code snippets. Structured content so that AI tools can more reliably generate valid Ray.Di code by covering typical patterns and edge cases.	llms-full.txt
Align factory pattern documentation diagram wording with LLM/reference terminology.	Updated the ASCII diagram labels from Japanese to English terms for runtime parameters and DI dependencies to better match code and LLM usage. Kept the surrounding Japanese explanation but clarified the visual separation of runtime parameters vs DI-injected dependencies. Ensured the previous/next navigation links remain intact while normalizing file ending formatting.	manuals/1.0/ja/study/02-object-creation/factory-pattern.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[coderabbitai]

📝 Walkthrough

Walkthrough

A documentation file underwent label translation from Japanese to English in diagram descriptions and formatting adjustments. The changes include translating three diagram labels and adding a trailing newline to the file.

Changes

Cohort / File(s)	Summary
Documentation Translation manuals/1.0/ja/study/02-object-creation/factory-pattern.md	Updated diagram labels from Japanese ("実行時パラメータ", "DI依存関係", "依存関係を持つオブジェクト") to English ("Runtime params", "DI dependencies", "Object with dependencies"); adjusted spacing/box alignment and added trailing newline.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A rabbit hops through translations true,
From 日本語 to English so new,
Labels dance in diagrams bright,
Spacing fixed, alignment right,
A newline added—complete and clean! 📝

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Title check	⚠️ Warning	The PR title 'Rewrite llms-full.txt as practical LLM reference' describes the main objective of rewriting a file, but the actual changeset modifies a Japanese markdown file about factory patterns with English translation changes, not llms-full.txt as the title suggests.	Update the PR title to accurately reflect the actual changes, such as 'Translate factory-pattern.md diagram labels to English' or similar to match the file modifications.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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 docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch rewrite-llms-full-txt

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[sourcery-ai]

Hey - I've left some high level feedback:

• In factory-pattern.md, the ASCII diagram labels were switched from Japanese to English while the surrounding explanation remains Japanese; consider keeping the terminology consistent (or bilingual) to avoid confusing readers.
• Given that llms-full.txt is intended as a practical LLM reference, it may help to standardize key terms and patterns (e.g., binding types, AOP, contextual bindings) so they match the exact terminology and phrasing used in the existing manuals to reduce ambiguity for code-generation.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- In `factory-pattern.md`, the ASCII diagram labels were switched from Japanese to English while the surrounding explanation remains Japanese; consider keeping the terminology consistent (or bilingual) to avoid confusing readers.
- Given that `llms-full.txt` is intended as a practical LLM reference, it may help to standardize key terms and patterns (e.g., binding types, AOP, contextual bindings) so they match the exact terminology and phrasing used in the existing manuals to reduce ambiguity for code-generation.

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}