Fix links for network documentation on repository#107
Conversation
And also to some network docs
Oops, missed these in the last commit
WalkthroughDocumentation links are reorganized across GECS and networking addon READMEs to use centralized paths. The network addon README updates its file structure and documentation links from local ChangesDocumentation Path Reorganization
🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 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 |
There was a problem hiding this comment.
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 `@addons/gecs/network/README.md`:
- Line 91: The tree in addons/gecs/network/README.md incorrectly shows
"../docs/network/" as a child of the directory; update the diagram so the path
reflects its actual location (e.g., change "../docs/network/" to
"../../docs/network/" if docs are two levels up, or remove it from the subtree
and list it as an external/sibling path) by editing the README.md entry that
currently reads "../docs/network/" so it matches the real repo layout.
🪄 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: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 9c0aae47-abad-4156-a1d6-00753c685cc6
📒 Files selected for processing (2)
addons/gecs/README.mdaddons/gecs/network/README.md
| │ ├── enet_transport_provider.gd # Default ENet transport | ||
| │ └── steam_transport_provider.gd # Steam transport (requires GodotSteam) | ||
| ├── docs/ | ||
| ├── ../docs/network/ |
There was a problem hiding this comment.
Fix misleading path in the file tree diagram.
../docs/network/ is shown as a child of addons/gecs_network/, but it is outside that directory. This can confuse users copying paths from the tree.
Suggested doc fix
addons/gecs_network/
@@
-├── ../docs/network/
+└── (see ../docs/network/ for centralized networking docs)📝 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.
| ├── ../docs/network/ | |
| └── (see ../docs/network/ for centralized networking docs) |
🤖 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 `@addons/gecs/network/README.md` at line 91, The tree in
addons/gecs/network/README.md incorrectly shows "../docs/network/" as a child of
the directory; update the diagram so the path reflects its actual location
(e.g., change "../docs/network/" to "../../docs/network/" if docs are two levels
up, or remove it from the subtree and list it as an external/sibling path) by
editing the README.md entry that currently reads "../docs/network/" so it
matches the real repo layout.
Hi! I was trying to navigate the documentation of the network addon and found most links pointed to missing pages. I've quickly fixed most of these links in
.md.Note I don't know what's the state of docs references inside Godot and the codebase, might as well be worth it checking that.
Summary by CodeRabbit