Skip to content

docs: fix broken River sync module link in the tutorial - #118

Merged
sanity merged 1 commit into
mainfrom
fix-river-sync-link
Aug 21, 2026
Merged

docs: fix broken River sync module link in the tutorial#118
sanity merged 1 commit into
mainfrom
fix-river-sync-link

Conversation

@sanity

@sanity sanity commented Aug 21, 2026

Copy link
Copy Markdown
Contributor

Problem

Err0rz asked on Matrix what happened to River's sync module, because the app-building tutorial links to it:

https://github.com/freenet/river/tree/main/ui/src/sync

That URL 404s. Investigating: the path has never existed in River's git history — git log --all --name-only across every commit shows no ui/src/sync, and at the commit contemporaneous with the doc line (Jan 2026) ui/src/ contained only components/, util/, and a handful of .rs files. So this is a doc error introduced in 7e6dc1f (2026-01-17, "Remove JS/TS UI example, focus on Dioxus/Rust"), not a River refactor that broke a previously-good link.

Nothing is missing from River. The code the tutorial means to point at is at ui/src/components/app/freenet_api/.

Approach

Repoint the link and, while there, name the files a reader actually needs so the link is useful rather than merely non-404. Descriptions verified against River main (419d013):

  • connection_manager.rs — the only file calling WebApi::start/WebSocket::new
  • freenet_synchronizer.rs — the sync loop / orchestrator
  • room_synchronizer.rs — issues ContractRequest::{Get,Put,Subscribe,Update}
  • response_handler/ — one module per response kind

It was the only broken github.com/freenet/river link in content/build/ (the other five all resolve).

Testing

hugo builds clean; confirmed the rendered build/manual/tutorial/index.html carries the new href. Both URLs checked over HTTP: old path 404, new path 200.

[AI-assisted - Claude]

The tutorial's "Connecting to Freenet" section linked to
https://github.com/freenet/river/tree/main/ui/src/sync, which 404s. That path
has never existed in River's history -- it was wrong when the line was written
in 7e6dc1f (2026-01-17), not the result of a later refactor.

River's WebSocket sync code lives at ui/src/components/app/freenet_api/. Point
at that and name the files a reader needs, so the link is useful rather than
just non-404.

Reported by Err0rz on Matrix.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_012S2nM1yfnXpVXpGf68GQ6J
@sanity
sanity merged commit dd39a9b into main Aug 21, 2026
3 checks passed
@sanity
sanity deleted the fix-river-sync-link branch August 21, 2026 23:12
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