Skip to content
This repository was archived by the owner on Aug 8, 2026. It is now read-only.

README: mark repo as legacy, fix docker example and stale bridge links, restore mdBook anchors - #3

Merged
danbarker merged 1 commit into
mainfrom
readme-legacy-status
Aug 8, 2026
Merged

danbarker merged 1 commit into
mainfrom
readme-legacy-status

Conversation

@danbarker

@danbarker danbarker commented Aug 8, 2026 •

Copy link
Copy Markdown

Status

  • Adds a legacy status banner as the first content block: Matron's current stack uses matron-journal as its sync server, and the Matrix transport this homeserver served has been retired (matron-bridge is journal-only; dev-boxer no longer installs a homeserver). The repo is kept as a mirror of upstream Tuwunel for existing Matrix-era deployments.
  • Rewrites the intro in past tense — it leads with what the repo is (a Tuwunel fork), then its historical role in the Matrix transport.

Corrections

  • Version reality stated explicitly: this tree tracks Tuwunel 1.6.0 while upstream is at 1.8.x (latest release v1.8.3, verified against matrix-construct/tuwunel releases). The ghcr.io/matronhq/matron-server:latest image is a weekly re-tag of ghcr.io/matrix-construct/tuwunel:latest (.github/workflows/sync-image.yml, cron 17 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.
  • Docker example fixed: the default listen port is 8008 (src/core/config/mod.rs, default_port), so the old -p 6167:6167 mapped a closed port. The example now sets TUWUNEL_PORT="6167", matching docs/deploying/docker-compose.yml, and notes the 8008 default.
  • Stale bridge links: claude-matrix-bridge renamed to matron-bridge in both places, described as "Ran Claude Code sessions and bridged them to Matrix (now journal-only)".
  • Ecosystem table: "Matron iOS" is now "Matron Apple" (iPhone and Mac), matron-android added, Matron Journal described as the current backbone, and this repo's row marked legacy.

Structure

  • mdBook anchors restored: docs/introduction.md includes README.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.
  • The "keep upstream tuwunel naming" note, previously stated four times, is collapsed into one Naming section; maintainer-policy sentences duplicated in CONTRIBUTING.md were removed from the README.
  • The Development section is now honest about CI (metadata and hygiene checks only — no build, no tests) and links development.md and docs/. A short Links section was added (CONTRIBUTING.md, RELEASE.md, docs/, upstream Tuwunel).

Notes for the owner

  • CONTRIBUTING.md still invites issues and PRs while the repo is dormant (no code work since 2026-04-30) — you may want to add a triage note there, or archive the repo. Archiving was deliberately left out of this PR as an owner decision.

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only README changes with no runtime, auth, or deployment code modifications.

Overview
Reframes README.md for 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:latest is 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:6167 matches a listening process (aligned with docs/deploying/docker-compose.yml).

Docs build: restores the six <!-- ANCHOR: ... --> pairs so docs/introduction.md includes for catchphrase, body, and footer resolve 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.

…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>
@danbarker
danbarker merged commit 8253644 into main Aug 8, 2026
2 checks passed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant