Link docs/FORMAT.md as the format specification in the README (closes #166) #175

Merged
clawbot merged 1 commits from issue-166-readme-format-spec-link into next 2026-10-07 15:59:11 +02:00
Collaborator

The first paragraph of README.md called mfer/mf.proto the format specification and linked to it. It now links docs/FORMAT.md as the specification and names mfer/mf.proto as the protobuf schema that document refers to for exact field numbers and types.

The other mentions already agreed, so nothing else changes: the README's Design section calls mfer/mf.proto the protobuf schema, its design questions point to both files, and AGENTS.md names docs/FORMAT.md as the format specification.

Judgement call: the new link is relative (docs/FORMAT.md), like the README's link to REPO_POLICIES.md. The old one was an absolute link to the main branch, and docs/FORMAT.md is not on main yet, so a link of that kind would be dead until next is merged.

Closes #166

Model: opus-5-5

The first paragraph of `README.md` called `mfer/mf.proto` the format specification and linked to it. It now links `docs/FORMAT.md` as the specification and names `mfer/mf.proto` as the protobuf schema that document refers to for exact field numbers and types. The other mentions already agreed, so nothing else changes: the README's Design section calls `mfer/mf.proto` the protobuf schema, its design questions point to both files, and `AGENTS.md` names `docs/FORMAT.md` as the format specification. Judgement call: the new link is relative (`docs/FORMAT.md`), like the README's link to `REPO_POLICIES.md`. The old one was an absolute link to the `main` branch, and `docs/FORMAT.md` is not on `main` yet, so a link of that kind would be dead until `next` is merged. Closes https://git.eeqj.de/sneak/mfer/issues/166 Model: opus-5-5
clawbot self-assigned this 2026-10-07 15:35:40 +02:00
clawbot added 1 commit 2026-10-07 15:35:40 +02:00
The README's opening paragraph called mfer/mf.proto the format specification
and linked to it. It now links docs/FORMAT.md, which is the specification, and
names mfer/mf.proto as the protobuf schema that document refers to for field
numbers and types. The link is relative, as the README's link to
REPO_POLICIES.md is, because docs/FORMAT.md is not on main yet.

Model: opus-5-5
clawbot added the needs-review label 2026-10-07 15:35:47 +02:00
Author
Collaborator

Review passed.

  • Gated on next at 4fe1ff2.
  • Judgement call: the relative link docs/FORMAT.md is accepted; it resolves on the Gitea repository page of any branch that contains the file, so on next now and on main once merged.
  • Not checked: how renderers outside Gitea treat the relative link.

Model: opus-5-5

Review passed. - Gated on `next` at `4fe1ff2`. - Judgement call: the relative link `docs/FORMAT.md` is accepted; it resolves on the Gitea repository page of any branch that contains the file, so on `next` now and on `main` once merged. - Not checked: how renderers outside Gitea treat the relative link. Model: opus-5-5
clawbot merged commit dce5e050c3 into next 2026-10-07 15:59:11 +02:00
clawbot deleted branch issue-166-readme-format-spec-link 2026-10-07 15:59:11 +02:00
Sign in to join this conversation.