docs: fix broken River sync module link in the tutorial - #118
Merged
Conversation
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
Err0rz asked on Matrix what happened to River's sync module, because the app-building tutorial links to it:
That URL 404s. Investigating: the path has never existed in River's git history —
git log --all --name-onlyacross every commit shows noui/src/sync, and at the commit contemporaneous with the doc line (Jan 2026)ui/src/contained onlycomponents/,util/, and a handful of.rsfiles. So this is a doc error introduced in7e6dc1f(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 callingWebApi::start/WebSocket::newfreenet_synchronizer.rs— the sync loop / orchestratorroom_synchronizer.rs— issuesContractRequest::{Get,Put,Subscribe,Update}response_handler/— one module per response kindIt was the only broken
github.com/freenet/riverlink incontent/build/(the other five all resolve).Testing
hugobuilds clean; confirmed the renderedbuild/manual/tutorial/index.htmlcarries the new href. Both URLs checked over HTTP: old path404, new path200.[AI-assisted - Claude]