|
| 1 | +// SPDX-License-Identifier: PMPL-1.0-or-later |
| 2 | +// SPDX-FileCopyrightText: 2024-2026 Jonathan D.A. Jewell (hyperpolymath) |
| 3 | + |
| 4 | +// ══════════════════════════════════════════════════════════════════════════════ |
| 5 | +// ⚠ DISAMBIGUATION — READ THIS FIRST |
| 6 | +// ══════════════════════════════════════════════════════════════════════════════ |
| 7 | +// |
| 8 | +// This repo is named vcs-ircd (GitHub: hyperpolymath/vcs-ircd). |
| 9 | +// The local directory may still read "vext" — that is a stale path artefact |
| 10 | +// from the rename; the canonical name is vcs-ircd. |
| 11 | +// |
| 12 | +// TWO THINGS WERE CALLED "VEXT". THEY ARE COMPLETELY UNRELATED. |
| 13 | +// |
| 14 | +// ┌─ YOU ARE HERE ─────────────────────────────────────────────────────────┐ |
| 15 | +// │ vcs-ircd (formerly: vext) │ |
| 16 | +// │ A pooled IRC notification daemon for version-control systems. │ |
| 17 | +// │ Rust async daemon (Tokio). Inspired by irker (Eric S. Raymond). │ |
| 18 | +// │ Sends commit/push notifications from Git repos to IRC channels. │ |
| 19 | +// │ Has nothing to do with cryptographic verification. │ |
| 20 | +// │ │ |
| 21 | +// │ Repo: github.com/hyperpolymath/vcs-ircd │ |
| 22 | +// │ Home: developer-ecosystem/satellites/git-tools/vcs-ircd │ |
| 23 | +// └────────────────────────────────────────────────────────────────────────┘ |
| 24 | +// |
| 25 | +// ┌─ NOT HERE — WRONG PLACE IF THIS IS WHAT YOU WANT ─────────────────────┐ |
| 26 | +// │ Vext (verification protocol) │ |
| 27 | +// │ A cryptographic feed-integrity protocol used by Burble. │ |
| 28 | +// │ BLAKE3 hash chains proving text feeds are chronological, complete, │ |
| 29 | +// │ uninjected, and attributable. Nothing to do with IRC or VCS. │ |
| 30 | +// │ │ |
| 31 | +// │ Lives at: burble/server/lib/burble/verification/vext.ex │ |
| 32 | +// │ burble/server/lib/burble/verification/vext_groove.ex │ |
| 33 | +// └────────────────────────────────────────────────────────────────────────┘ |
| 34 | +// |
| 35 | +// If you landed here looking for the Vext verification protocol → go to burble. |
| 36 | +// If you landed here looking for the IRC VCS notifier → you are in the right place. |
| 37 | +// |
| 38 | +// ══════════════════════════════════════════════════════════════════════════════ |
| 39 | + |
| 40 | +[identity] |
| 41 | +name = "vcs-ircd" |
| 42 | +formerly = "vext" |
| 43 | +kind = "satellite" |
| 44 | +parent-repo = "developer-ecosystem" |
| 45 | +path = "satellites/git-tools/vcs-ircd" |
| 46 | +github = "hyperpolymath/vcs-ircd" |
| 47 | + |
| 48 | +[purpose] |
| 49 | +summary = "Pooled IRC notification daemon for VCS events (Git push, commit, PR)" |
| 50 | +tech = "Rust (Tokio async), connection pooling, TLS, rate-limiting" |
| 51 | +origin = "Inspired by irker (ESR); modernised rewrite with async I/O" |
| 52 | + |
| 53 | +[disambiguation] |
| 54 | +this-is-not = "The Vext cryptographic verification protocol" |
| 55 | +that-lives-at = "burble/server/lib/burble/verification/vext.ex" |
| 56 | + |
| 57 | +[invariants] |
| 58 | +// Critical rules for AI agents working in this repo |
| 59 | +rules = [ |
| 60 | + "Do NOT confuse this with the Vext feed-verification protocol in burble", |
| 61 | + "The local directory may still be named 'vext' — the canonical name is vcs-ircd", |
| 62 | + "This is an IRC daemon. It does not do cryptographic verification of anything", |
| 63 | + "Parent: developer-ecosystem satellite. Push to github.com/hyperpolymath/vcs-ircd", |
| 64 | +] |
0 commit comments