This repository was archived by the owner on Aug 8, 2026. It is now read-only.
Repository navigation
README: mark repo as legacy, fix docker example and stale bridge links, restore mdBook anchors - #3
Merged
Merged
Conversation
…ore anchors - Add a legacy status banner: Matron's stack now runs on matron-journal; the Matrix transport this homeserver served has been retired. The repo stays as an upstream Tuwunel mirror for existing Matrix-era deployments. - Rewrite the intro in past tense and state the version reality: the tree tracks Tuwunel 1.6.0 while upstream is at 1.8.x (v1.8.3), and the GHCR image is a weekly re-tag of upstream, not a build of this source. - Rename claude-matrix-bridge -> matron-bridge (repo was renamed) and mark it journal-only; update the ecosystem table (Matron Apple, add matron-android, journal as the current backbone, this repo as legacy). - Fix the docker run example: the default listen port is 8008, so -p 6167:6167 mapped a closed port. Add TUWUNEL_PORT=6167 to match docs/deploying/docker-compose.yml. - Restore the mdBook ANCHOR comments (catchphrase, body, footer) so the three includes in docs/introduction.md resolve again. - Collapse the four repeated upstream-naming notes into one Naming section; drop maintainer-policy sentences already in CONTRIBUTING.md. - Make the Development section honest (CI runs metadata and hygiene checks only) and add a Links section. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Status
Corrections
ghcr.io/matronhq/matron-server:latestimage is a weekly re-tag ofghcr.io/matrix-construct/tuwunel:latest(.github/workflows/sync-image.yml, cron17 4 * * 1) and does not correspond to the source in this repo. This fork-behind-upstream and image-vs-source divergence is the motivation for calling it out prominently.src/core/config/mod.rs,default_port), so the old-p 6167:6167mapped a closed port. The example now setsTUWUNEL_PORT="6167", matchingdocs/deploying/docker-compose.yml, and notes the 8008 default.claude-matrix-bridgerenamed tomatron-bridgein both places, described as "Ran Claude Code sessions and bridged them to Matrix (now journal-only)".Structure
docs/introduction.mdincludesREADME.md:catchphrase,:body, and:footer, but the last README rewrite deleted all six ANCHOR comments, breaking the docs build. This PR restores the three pairs (placement modeled on b7c2567) around the current intro, main body, and license sections so all three includes resolve. No docs/ files were edited.Notes for the owner
🤖 Generated with Claude Code
Note
Low Risk
Documentation-only README changes with no runtime, auth, or deployment code modifications.
Overview
Reframes
README.mdfor a legacy, mirror-only repo and fixes a few operator-facing mistakes.The intro now opens with a legacy banner (journal is the current sync path; Matrix transport and old bridge naming are retired) and describes this tree in past tense as a Tuwunel fork kept for existing Matrix-era deployments.
New clarity on versions and images: source here tracks Tuwunel 1.6.0 while upstream is 1.8.x;
ghcr.io/matronhq/matron-server:latestis a weekly re-tag of upstream’s image and is not built from this repo.Docker example: adds
TUWUNEL_PORT="6167"and documents the default 8008 listen port so-p 6167:6167matches a listening process (aligned withdocs/deploying/docker-compose.yml).Docs build: restores the six
<!-- ANCHOR: ... -->pairs sodocs/introduction.mdincludes forcatchphrase,body, andfooterresolve again.Housekeeping: ecosystem table updates (Matron Apple/Android, journal as backbone, legacy server row);
claude-matrix-bridge→matron-bridge; collapses repeated upstream-naming notes into Naming; Development states CI is metadata/hygiene only; adds a Links section.Reviewed by Cursor Bugbot for commit c6ba6fa. Bugbot is set up for automated code reviews on this repo. Configure here.