Skip to content

Fix links for network documentation on repository #107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
flamenco687 wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Fix links for network documentation on repository #107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fef33a0
Fix docs links in network README.md
flamenco687 May 18, 2026
7b2617b
Fix links to network README.md
flamenco687 May 18, 2026
76c4406
Fix links to network docs in README.md
flamenco687 May 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions addons/gecs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@

### Networking (Optional addon)

- **[GECS Network Addon](../gecs_network/README.md)** - Multiplayer synchronization for GECS entities. Supports **transport providers** (ENet, Steam, or custom backends) that can be swapped without changing game code. See the addon docs for [Configuration & NetAdapter](../gecs_network/docs/configuration.md), [Examples](../gecs_network/docs/examples.md), and [Troubleshooting](../gecs_network/docs/troubleshooting.md).
- **[GECS Network Addon](network/README.md)** - Multiplayer synchronization for GECS entities. Supports **transport providers** (ENet, Steam, or custom backends) that can be swapped without changing game code. See the addon docs for [Configuration & NetAdapter](docs/network/configuration.md), [Examples](docs/network/examples.md), and [Troubleshooting](docs/network/troubleshooting.md).

### Optimization & Advanced (As needed)

Expand Down Expand Up @@ -71,10 +71,10 @@

| Topic | Document | Description |
| ------------------- | ------------------------------------------------------------------- | -------------------------------------------------- |
| **Overview** | [GECS Network Addon](../gecs_network/README.md) | Multiplayer sync, transport providers (ENet/Steam) |
| **Configuration** | [Configuration & NetAdapter](../gecs_network/docs/configuration.md) | NetAdapter, priority tiers, ProjectSettings |
| **Examples** | [Examples](../gecs_network/docs/examples.md) | Players, enemies, projectiles, abilities |
| **Troubleshooting** | [Troubleshooting](../gecs_network/docs/troubleshooting.md) | Common networking issues and migration guide |
| **Overview** | [GECS Network Addon](network/README.md) | Multiplayer sync, transport providers (ENet/Steam) |
| **Configuration** | [Configuration & NetAdapter](docs/network/configuration.md) | NetAdapter, priority tiers, ProjectSettings |
| **Examples** | [Examples](docs/network/examples.md) | Players, enemies, projectiles, abilities |
| **Troubleshooting** | [Troubleshooting](docs/network/troubleshooting.md) | Common networking issues and migration guide |

### Optimization & Debugging

Expand Down
22 changes: 11 additions & 11 deletions addons/gecs/network/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ addons/gecs_network/
├── transports/
│ ├── enet_transport_provider.gd # Default ENet transport
│ └── steam_transport_provider.gd # Steam transport (requires GodotSteam)
├── docs/
├── ../docs/network/

@coderabbitai coderabbitai Bot May 18, 2026

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.

│ ├── components.md # CN_NetworkIdentity, CN_NetSync, CN_NativeSync, markers
│ ├── architecture.md # Handler architecture, sync pipeline diagram
│ ├── authority.md # Authority query patterns (CN_LocalAuthority, CN_ServerAuthority)
Expand All @@ -113,16 +113,16 @@ addons/gecs_network/

## Documentation

- [Components](docs/components.md)
- [Architecture](docs/architecture.md)
- [Authority](docs/authority.md)
- [Configuration](docs/configuration.md)
- [Sync Patterns](docs/sync-patterns.md)
- [Custom Sync Handlers](docs/custom-sync-handlers.md)
- [Best Practices](docs/best-practices.md)
- [Examples](docs/examples.md)
- [Troubleshooting](docs/troubleshooting.md)
- [Migration Guide](docs/migration-v1-to-v2.md)
- [Components](../docs/network/components.md)
- [Architecture](../docs/network/architecture.md)
- [Authority](../docs/network/authority.md)
- [Configuration](../docs/network/configuration.md)
- [Sync Patterns](../docs/network/sync-patterns.md)
- [Custom Sync Handlers](../docs/network/custom-sync-handlers.md)
- [Best Practices](../docs/network/best-practices.md)
- [Examples](../docs/network/examples.md)
- [Troubleshooting](../docs/network/troubleshooting.md)
- [Migration Guide](../docs/network/migration-v1-to-v2.md)

## License

Expand Down