olympus/infra-forge

Fork 0

Rules find a home; source comments go self-contained #9

New issue

Closed

opened 2026-10-06 10:13:23 +00:00 by pit · 1 comment

pit commented

2026-10-06 10:13:23 +00:00

Owner

Part of #7

What to build

Give the standing working rules a home of their own and detach the source comments from the numbered conventions. The rules that are really "read before you work here" move to the agent context file as named rules, and every source comment that cites a convention by number or points at the README is rewritten to stand on its own, so nothing dangles once the numbers are gone.

Acceptance criteria

The agent context file carries named rules (no numbers): Secrets — nothing plaintext in the repo, vault-encrypted files only, never commit plaintext staging files; and Privacy — do not publish the DDNS hostname or the external IP, with third-party public hosts and public service domains explicitly allowed.
The agent context file points at the docs entry point, alongside its existing pointers to the agent docs and the domain docs.
"Version pins live in one place" is not carried over as a rule (it is self-evident from the role defaults).
No source comment under the ansible or tofu trees references a numbered convention, and none points at the README or the agent context file.
No behavioural change: the tofu stacks and the ansible role behave exactly as before; the only code edits are comment rewrites.
Lands as its own PR.

Blocked by

Part of #7 ## What to build Give the standing working rules a home of their own and detach the source comments from the numbered conventions. The rules that are really "read before you work here" move to the agent context file as named rules, and every source comment that cites a convention by number or points at the README is rewritten to stand on its own, so nothing dangles once the numbers are gone. ## Acceptance criteria - [ ] The agent context file carries named rules (no numbers): Secrets — nothing plaintext in the repo, vault-encrypted files only, never commit plaintext staging files; and Privacy — do not publish the DDNS hostname or the external IP, with third-party public hosts and public service domains explicitly allowed. - [ ] The agent context file points at the docs entry point, alongside its existing pointers to the agent docs and the domain docs. - [ ] "Version pins live in one place" is not carried over as a rule (it is self-evident from the role defaults). - [ ] No source comment under the ansible or tofu trees references a numbered convention, and none points at the README or the agent context file. - [ ] No behavioural change: the tofu stacks and the ansible role behave exactly as before; the only code edits are comment rewrites. - [ ] Lands as its own PR. ## Blocked by - #8

pit added the

ready-for-agent

label

2026-10-06 10:13:39 +00:00

pit referenced this issue from a commit

2026-10-06 10:44:06 +00:00

docs: add the docs tree — entry point, architecture, runbooks, ADRs, glossary, license (issue #8)

pit referenced this issue

2026-10-06 10:44:11 +00:00

docs: add the docs tree — entry point, architecture, runbooks, ADRs, glossary, license #13

pit referenced this issue from a commit

2026-10-06 10:44:28 +00:00

docs: add the docs tree — entry point, architecture, runbooks, ADRs, glossary, license (issue #8)

pit referenced this issue

2026-10-06 10:44:38 +00:00

Docs tree lands: entry point, architecture, runbooks, ADRs, glossary, license #8

pit referenced this issue from a commit

2026-10-06 10:52:01 +00:00

docs: add the docs tree — entry point, architecture, runbooks, ADRs, glossary, license (issue #8)

pit referenced this issue from a commit

2026-10-06 11:01:08 +00:00

docs: add the docs tree — entry point, architecture, runbooks, ADRs, glossary, license (issue #8)

pit referenced this issue from a commit

2026-10-06 11:22:06 +00:00

Rules find a home; source comments go self-contained (#9)

pit referenced this issue

2026-10-06 11:22:12 +00:00

Rules find a home; source comments go self-contained (#9) #15

pit commented

2026-10-06 11:22:20 +00:00

Author

Owner

Implemented on hermes/9-rules-find-a-home, PR #15: pit/infra-forge#15

AGENTS.md gains a ## Standing rules section with named rules — Secrets and Privacy — and a ## Docs pointer at docs/index.md, alongside the existing agent-docs and domain-docs pointers. "Version pins live in one place" is not carried over: it is self-evident from the role defaults.

Three comments that leaned on the numbered list are detached so nothing dangles once #10 deletes the list: ansible/roles/forgejo/defaults/main.yml ("convention 4"), ansible/ansible.cfg ("see README"), and docs/adr/0001-…md (which cited both "convention 4" and "README convention 7"; its carve-out bullet is renamed to state the rule itself). The ADR is under docs/, not the ansible/tofu trees the AC names, but leaving it would dangle exactly as the parent's problem statement describes.

Citation check: grep -rniE 'convention ?[0-9]|README|AGENTS\.md' ansible tofu returns nothing. No behavioural change — the only code edits are comment rewrites; tofu validate and tofu fmt -check pass on the Guest stack. Four files, +33/-12.

Implemented on `hermes/9-rules-find-a-home`, PR #15: https://forgejo.thepit.space/pit/infra-forge/pulls/15 `AGENTS.md` gains a `## Standing rules` section with named rules — **Secrets** and **Privacy** — and a `## Docs` pointer at `docs/index.md`, alongside the existing agent-docs and domain-docs pointers. "Version pins live in one place" is not carried over: it is self-evident from the role defaults. Three comments that leaned on the numbered list are detached so nothing dangles once #10 deletes the list: `ansible/roles/forgejo/defaults/main.yml` ("convention 4"), `ansible/ansible.cfg` ("see README"), and `docs/adr/0001-…md` (which cited both "convention 4" and "README convention 7"; its carve-out bullet is renamed to state the rule itself). The ADR is under `docs/`, not the ansible/tofu trees the AC names, but leaving it would dangle exactly as the parent's problem statement describes. Citation check: `grep -rniE 'convention ?[0-9]|README|AGENTS\.md' ansible tofu` returns nothing. No behavioural change — the only code edits are comment rewrites; `tofu validate` and `tofu fmt -check` pass on the Guest stack. Four files, +33/-12.

pit referenced this issue

2026-10-06 11:23:47 +00:00

README goes thin #10

pit referenced this issue from a commit

2026-10-06 11:43:41 +00:00

Rules find a home; source comments go self-contained (#9) (#15)

pit closed this issue

2026-10-06 12:06:18 +00:00