Skip to content

Fix links for network documentation on repository#107

Open
flamenco687 wants to merge 3 commits into
csprance:mainfrom
flamenco687:fix-network-docs-links
Open

Fix links for network documentation on repository#107
flamenco687 wants to merge 3 commits into
csprance:mainfrom
flamenco687:fix-network-docs-links

Conversation

@flamenco687
Copy link
Copy Markdown
Contributor

@flamenco687 flamenco687 commented May 18, 2026

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

  • Documentation
    • Reorganized networking addon documentation paths and updated internal navigation links to reflect improved documentation directory structure.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 18, 2026

Walkthrough

Documentation 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 docs/ to ../docs/network/ paths. The GECS main README updates its networking section references from ../gecs_network/ to the new network/ and docs/network/ paths.

Changes

Documentation Path Reorganization

Layer / File(s) Summary
Network addon documentation structure and links update
addons/gecs/network/README.md
File structure references and documentation links are reorganized from local docs/ paths to a centralized ../docs/network/ directory, updating all documentation page references (components, architecture, authority, configuration, sync patterns, custom sync handlers, best practices, examples, troubleshooting, and migration guide).
GECS main README networking references update
addons/gecs/README.md
The Learning Path "GECS Network Addon" link and the Networking optional addon topic table (Overview, Configuration, Examples, Troubleshooting) are updated to reference the new network/ and docs/network/ paths instead of the prior ../gecs_network/ directory.

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Fix links for network documentation on repository' accurately describes the main objective of the pull request, which is fixing broken documentation links in the network addon. The title is clear, concise, and directly reflects the changeset's primary purpose.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

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

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8611b56 and 76c4406.

📒 Files selected for processing (2)
  • addons/gecs/README.md
  • addons/gecs/network/README.md

│ ├── enet_transport_provider.gd # Default ENet transport
│ └── steam_transport_provider.gd # Steam transport (requires GodotSteam)
├── docs/
├── ../docs/network/
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

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.

Suggested change
── ../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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant