update documentation links and improve homepage layout - #28
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (2)
📝 WalkthroughWalkthroughThis PR updates documentation links to reflect a path reorganization, improves minor documentation formatting, pins the webpack version for reproducible builds, and redesigns the homepage with new CSS styling and a static TypeScript implementation replacing dynamic Docusaurus context usage. ChangesDocumentation Maintenance
Project Configuration Updates
Homepage Redesign
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. 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}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
src/pages/index.tsx (2)
150-153: ⚡ Quick winLazy-load the secondary reference image.
This image is below the fold; adding lazy loading and async decoding improves initial render performance.
Suggested fix
<img src="/Getting Started/introduction/img/editor_intro_search_help.webp" alt="Redot editor help search panel" + loading="lazy" + decoding="async" />🤖 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 `@src/pages/index.tsx` around lines 150 - 153, The inline <img> used in src/pages/index.tsx for the secondary reference ("Redot editor help search panel") is below the fold and should be lazy-loaded; update the <img> element (the tag rendering the "/Getting Started/introduction/img/editor_intro_search_help.webp" asset) to include loading="lazy" and decoding="async" (and optionally supply width and height attributes if available) so the browser defers fetching/decoding until needed and improves initial render performance.
111-113: ⚡ Quick winFollow Docusaurus best practices for static asset URLs.
Lines 111 and 151 use absolute root-relative paths for images. While these work with the current
baseUrl: '/'configuration, Docusaurus recommends using theuseBaseUrl()hook for static assets to ensure portability across different deployment contexts and to properly handle URL encoding for paths containing spaces.Suggested fix
import type {ReactNode} from 'react'; import Link from '`@docusaurus/Link`'; +import useBaseUrl from '`@docusaurus/useBaseUrl`'; import Layout from '`@theme/Layout`'; import Heading from '`@theme/Heading`'; @@ <img - src="/Getting Started/introduction/img/editor_intro_workspace_3d.webp" + src={useBaseUrl('/Getting%20Started/introduction/img/editor_intro_workspace_3d.webp')} alt="Redot editor showing a 3D workspace" /> @@ <img - src="/Getting Started/introduction/img/editor_intro_search_help.webp" + src={useBaseUrl('/Getting%20Started/introduction/img/editor_intro_search_help.webp')} alt="Redot editor help search panel" />Also applies to: 151-153
🤖 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 `@src/pages/index.tsx` around lines 111 - 113, Update the image src usage in src/pages/index.tsx to use the Docusaurus hook useBaseUrl: import useBaseUrl from '`@docusaurus/useBaseUrl`', call const img = useBaseUrl('/Getting Started/introduction/img/editor_intro_workspace_3d.webp') (and similarly for the other image path) and replace the hardcoded src strings with those hook results so paths (including spaces) are correctly encoded and respect baseUrl; apply the same change for the second image reference in the file.
🤖 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 `@docs/Classes/JavaClassWrapper.md`:
- Line 41: The documentation link contains a misspelling: change the filename
segment "andriod" to "android" in the markdown link
"../tutorials/platform/android/javaclasswrapper_and_andriodruntimeplugin.md" so
it becomes
"../tutorials/platform/android/javaclasswrapper_and_androidruntimeplugin.md"
(fix the token "andriod" to "android" in the link text).
In `@docs/Classes/Signal.md`:
- Line 206: The link in Signal.md uses a mismatched path "../Getting
Started/step_by_step/signals.md" which will break on case-sensitive filesystems;
update the href to the consistent lowercase, underscore path
"../getting_started/step_by_step/signals.md" (i.e., replace "Getting Started"
with "getting_started") so the "[Using Signals]" link resolves correctly.
---
Nitpick comments:
In `@src/pages/index.tsx`:
- Around line 150-153: The inline <img> used in src/pages/index.tsx for the
secondary reference ("Redot editor help search panel") is below the fold and
should be lazy-loaded; update the <img> element (the tag rendering the "/Getting
Started/introduction/img/editor_intro_search_help.webp" asset) to include
loading="lazy" and decoding="async" (and optionally supply width and height
attributes if available) so the browser defers fetching/decoding until needed
and improves initial render performance.
- Around line 111-113: Update the image src usage in src/pages/index.tsx to use
the Docusaurus hook useBaseUrl: import useBaseUrl from '`@docusaurus/useBaseUrl`',
call const img = useBaseUrl('/Getting
Started/introduction/img/editor_intro_workspace_3d.webp') (and similarly for the
other image path) and replace the hardcoded src strings with those hook results
so paths (including spaces) are correctly encoded and respect baseUrl; apply the
same change for the second image reference in the file.
🪄 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: defaults
Review profile: CHILL
Plan: Pro
Run ID: 37e85e11-2334-4ca1-bcb4-63c5b1ec6f9c
⛔ Files ignored due to path filters (1)
package-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (16)
.gitignoredocs/Classes/EditorSettings.mddocs/Classes/GDExtension.mddocs/Classes/GDExtensionManager.mddocs/Classes/JavaClassWrapper.mddocs/Classes/JavaScriptBridge.mddocs/Classes/Node.mddocs/Classes/Object.mddocs/Classes/ResourceImporterTexture.mddocs/Classes/Signal.mddocs/Classes/Variant.mddocs/Contributing/Documentation/updating_the_class_reference.mddocs/tutorials/ui/bbcode_in_richtextlabel.mdpackage.jsonsrc/pages/index.module.csssrc/pages/index.tsx
| ## Tutorials | ||
|
|
||
| - [Using Signals](../getting_started/step_by_step/signals.md) | ||
| - [Using Signals](../Getting Started/step_by_step/signals.md) |
There was a problem hiding this comment.
Likely broken tutorial link path (Getting Started vs getting_started).
This path change likely breaks on case-sensitive environments and introduces a spaced directory name that doesn’t match the docs path pattern used elsewhere. Please restore the lowercase path.
Suggested fix
-- [Using Signals](../Getting Started/step_by_step/signals.md)
+- [Using Signals](../getting_started/step_by_step/signals.md)📝 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.
| - [Using Signals](../Getting Started/step_by_step/signals.md) | |
| - [Using Signals](../getting_started/step_by_step/signals.md) |
🤖 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 `@docs/Classes/Signal.md` at line 206, The link in Signal.md uses a mismatched
path "../Getting Started/step_by_step/signals.md" which will break on
case-sensitive filesystems; update the href to the consistent lowercase,
underscore path "../getting_started/step_by_step/signals.md" (i.e., replace
"Getting Started" with "getting_started") so the "[Using Signals]" link resolves
correctly.
There was a problem hiding this comment.
Hey, just as an FYI, everything in the /docs/Classes/ directory is generated, and any changes will be lost next time we sync the class DB changes with the engine.
To effect the output here, we need to address the XML files they are generated from here or by editing the script responsible for generating them.
2 participants
Added custom homepage and updated several links showing as warnings to missing files
Summary by CodeRabbit
New Features
Documentation
Chores