docs(readme): add examples section with links to basic usage#586
Merged
Conversation
Contributor
📝 WalkthroughWalkthroughUpdated README.md to redirect example image links to new repository paths and added a "Hello World" section directing users to example folders across the codebase. Additionally, condensed error logging formatting in a CharacterControllerUsage example file without changing functionality. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested labels
Poem
🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (2 warnings)
✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 40-44: Edit the "Hello World" section header and sentence to fix
grammar and improve clarity: change "basics examples" to "basic examples",
replace the glob pattern "`**/examples`" with clearer wording such as "the
examples/ directory" (or "examples folder") and rephrase the awkward clause to
something like "For a simple 'Hello World' demonstration, see this example"
while keeping the existing link to the BasicCoreUsage example; update the full
sentence to read clearly and concisely.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
|
Contributor
Author
|
@coderabbitai review |
Contributor
✅ Actions performedReview triggered.
|
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (1)
README.md (1)
40-44: Consider simplifying the parenthetical for better clarity.The parenthetical explanation on line 43 is a bit complex and could be clearer. The phrase "in
root,src/engine/examplesandexamplesfolder in any plugin folder" packs multiple nested concepts into one clause, which may confuse readers.Consider a clearer structure:
📝 Optional clarity improvement
-You can find basic examples in the `examples/` (in `root`, `src/engine/examples` and `examples` folder in any plugin folder in `src/plugin/`) folders throughout the project. For a "hello world" example, check [this one](https://github.com/EngineSquared/EngineSquared/tree/main/src/engine/examples/BasicCoreUsage). +You can find basic examples throughout the project in several locations: `examples/` at the root, `src/engine/examples/`, and the `examples/` folder within any plugin under `src/plugin/`. For a "hello world" example, check [this one](https://github.com/EngineSquared/EngineSquared/tree/main/src/engine/examples/BasicCoreUsage).🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 40 - 44, The parenthetical in the "Hello World" section is confusing; rewrite it to list the example locations clearly and separately. Replace the clause "in `root`, `src/engine/examples` and `examples` folder in any plugin folder" with a clearer list such as: examples/ in the repo root, src/engine/examples, and the examples/ folder inside each plugin directory; keep the existing link to the BasicCoreUsage example unchanged. Ensure the revised sentence appears under the "Hello World" heading and preserves backticks around folder names.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@README.md`:
- Around line 40-44: The parenthetical in the "Hello World" section is
confusing; rewrite it to list the example locations clearly and separately.
Replace the clause "in `root`, `src/engine/examples` and `examples` folder in
any plugin folder" with a clearer list such as: examples/ in the repo root,
src/engine/examples, and the examples/ folder inside each plugin directory; keep
the existing link to the BasicCoreUsage example unchanged. Ensure the revised
sentence appears under the "Hello World" heading and preserves backticks around
folder names.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 7af4ebc1-3c52-40ae-8862-386a4de72856
📒 Files selected for processing (2)
README.mdexamples/CharacterControllerUsage/src/main.cpp
✅ Files skipped from review due to trivial changes (1)
- examples/CharacterControllerUsage/src/main.cpp
Contributor
|
Caution Failed to replace (edit) comment. This is likely due to insufficient permissions or the comment being deleted. Error details |
Miou-zora
added a commit
that referenced
this pull request
May 24, 2026
# Pull Request ## Description I added a link and an explanation on how to check examples and indicated where is an "hello world" looks like. ## Related Issues (Put "None" if there are no related issues) close #527 ## Type of Change Please delete options that are not relevant. - Documentation update ## Changes Made List the main changes in this PR: - Added a link and an explanation on how to check examples - Indicated where is an "hello world" looks like ## Testing Describe the tests you ran to verify your changes. Please delete options that are not relevant. None ### Test Environment - OS: macOS - Compiler: Clang ## Screenshots/Videos (Put "None" if there are no related issues) None ## Documentation Please delete options that are not relevant. - I have updated the relevant documentation ## Checklist (Don't delete any options) - [x] My code follows the style guidelines of this project - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas - [x] My changes generate no new warnings - [x] I have added tests that prove my fix is effective or that my feature works - [x] New and existing unit tests pass locally with my changes - [x] Any dependent changes have been merged and published ## Breaking Changes (Put "None" if there are no related issues) None ## Additional Notes (Put "None" if there are no related issues) None <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Updated links to Lights and Material example code to reflect new repository structure. * Added "Hello World" section with guidance on accessing basic examples across example folders. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request
Description
I added a link and an explanation on how to check examples and indicated where is an "hello world" looks like.
Related Issues (Put "None" if there are no related issues)
close #527
Type of Change
Please delete options that are not relevant.
Changes Made
List the main changes in this PR:
Testing
Describe the tests you ran to verify your changes. Please delete options that are not relevant.
None
Test Environment
Screenshots/Videos (Put "None" if there are no related issues)
None
Documentation
Please delete options that are not relevant.
Checklist (Don't delete any options)
Breaking Changes (Put "None" if there are no related issues)
None
Additional Notes (Put "None" if there are no related issues)
None
Summary by CodeRabbit