docs: add Mirrors section to README (canonical + GitHub) #490

New issue

Closed

opened 2026-08-09 15:09:36 +00:00 by igor · 0 comments

igor commented

2026-08-09 15:09:36 +00:00

Collaborator

Deliverables

Insert this section into README.md after the intro paragraph(s), before the first existing ## section, exactly:

## Mirrors

**Canonical repo: <https://git.sherver.org/joshtronic/igor>**

Mirrored for _your_ convenience:

- <https://github.com/joshtronic/igor>

_I don't monitor these services or accept pull/merge requests on them._

Generalize the Forgejo-specific wording in README.md (three spots as of today):
- Line ~4: "claims one Agent-labeled Forgejo issue" -> "claims one Agent-labeled issue from the git forge" (or equivalent).
- Line ~63: git clone <forgejo-url>/<bot-user>/igor -> git clone <git-repo-url> ~/.local/share/agent (the placeholder is the repo URL itself, forge-agnostic).
- Line ~87: "Forgejo's Advanced label template + a custom Agent label" -> keep the substance, name Forgejo only as the current example: e.g. "the forge's label set (on Forgejo, the Advanced template) + a custom Agent label".
  Keep any Forgejo mention that is genuinely about the current implementation (API specifics in docs/ are fine and out of scope) -- the README's job is to describe the harness, and the harness's forge is an implementation detail.

Out of scope

Configuring the actual push-mirror (Forgejo repo settings + the GitHub-side repo) -- operator action.
Any file other than README.md; any docs/ content.

Verification

The repo test command passes; git diff shows hunks only in README.md; grep -c -i forgejo README.md drops to the implementation-example mentions only.

Two README changes in one docs PR: the Mirrors section, and de-Forgejo-ing the wording (the harness is headed toward multi-forge/multi-harness portability -- the README shouldn't read as Forgejo-only). ## Deliverables 1. Insert this section into `README.md` after the intro paragraph(s), before the first existing `##` section, exactly: ```markdown ## Mirrors **Canonical repo: <https://git.sherver.org/joshtronic/igor>** Mirrored for _your_ convenience: - <https://github.com/joshtronic/igor> _I don't monitor these services or accept pull/merge requests on them._ ``` 2. Generalize the Forgejo-specific wording in `README.md` (three spots as of today): - Line ~4: "claims one `Agent`-labeled Forgejo issue" -> "claims one `Agent`-labeled issue from the git forge" (or equivalent). - Line ~63: `git clone <forgejo-url>/<bot-user>/igor` -> `git clone <git-repo-url> ~/.local/share/agent` (the placeholder is the repo URL itself, forge-agnostic). - Line ~87: "Forgejo's Advanced label template + a custom `Agent` label" -> keep the substance, name Forgejo only as the current example: e.g. "the forge's label set (on Forgejo, the Advanced template) + a custom `Agent` label". Keep any Forgejo mention that is genuinely about the current implementation (API specifics in docs/ are fine and out of scope) -- the README's job is to describe the harness, and the harness's forge is an implementation detail. ## Out of scope - Configuring the actual push-mirror (Forgejo repo settings + the GitHub-side repo) -- operator action. - Any file other than `README.md`; any docs/ content. ## Verification - The repo test command passes; `git diff` shows hunks only in README.md; `grep -c -i forgejo README.md` drops to the implementation-example mentions only.

Rows
Columns