claudiomaradonna/azkaban
1
1
Fork 0
Code Issues Pull requests Activity

docs: drop text azkaban's readers do not need #41

Merged
claudiomaradonna merged 1 commit from docs/trim-reader-noise into master 2026-10-08 09:04:30 +02:00
Conversation 0 Commits 1 Files changed 4 +98 -144
motoko commented 2026-10-08 08:59:36 +02:00
Collaborator
Copy link

Why

The README and the docs pages carried passages written for the
maintainer's own workflow, internal mechanics, and repeated text, rather
than for the people who install, run, or extend azkaban. The
relative-worktree paragraph and the host Git 2.48 prerequisite are the
clearest cases: they reflect this repository's worktree habit, and the
launcher never runs git on the host.

What changed

  • README: the bundled tools fold into one sentence pointing at
    containers/Dockerfile; installer and dispatcher internals, the Codex
    override rationale, the fallback image-name algorithm, quoted dry-run
    and macOS messages, and the OpenCode commands the OpenCode section
    already owns are gone; Historical provenance becomes a License pointer
    to COPYRIGHT.
  • The smoke-gate descriptions in docs/development.md and
    docs/adding-a-client.md now include the worktree, forge-CLI, and
    Prettier checks the gate runs.
  • Client registration has one home in Registration points, and the
    restated Verify rule is gone.
  • In the bot-account steps, the ssh-agent description becomes a
    paragraph, and the advice on naming the forge in a project's
    AGENTS.md is dropped.

No behavior changes.

Verification

make lint && .agents/hooks/shellcheck.sh repo && make test passed with
ShellCheck installed; prettier --check README.md docs/*.md passed.
make smoke-images was not run, since no code or image changed.

## Why The README and the docs pages carried passages written for the maintainer's own workflow, internal mechanics, and repeated text, rather than for the people who install, run, or extend azkaban. The relative-worktree paragraph and the host Git 2.48 prerequisite are the clearest cases: they reflect this repository's worktree habit, and the launcher never runs git on the host. ## What changed - README: the bundled tools fold into one sentence pointing at `containers/Dockerfile`; installer and dispatcher internals, the Codex override rationale, the fallback image-name algorithm, quoted dry-run and macOS messages, and the OpenCode commands the OpenCode section already owns are gone; Historical provenance becomes a License pointer to `COPYRIGHT`. - The smoke-gate descriptions in `docs/development.md` and `docs/adding-a-client.md` now include the worktree, forge-CLI, and Prettier checks the gate runs. - Client registration has one home in Registration points, and the restated Verify rule is gone. - In the bot-account steps, the ssh-agent description becomes a paragraph, and the advice on naming the forge in a project's `AGENTS.md` is dropped. No behavior changes. ## Verification `make lint && .agents/hooks/shellcheck.sh repo && make test` passed with ShellCheck installed; `prettier --check README.md docs/*.md` passed. `make smoke-images` was not run, since no code or image changed. 
The README and the docs pages carried passages written for the
maintainer's own workflow, internal mechanics, and repeated text,
rather than for the people who install, run, or extend azkaban.

README: drop the relative-worktree paragraph and the host Git 2.48
prerequisite, which reflect this repository's worktree habit and that
the launcher never runs git on the host; fold the bundled tools into
one sentence pointing at the Dockerfile; drop installer and dispatcher
internals, the Codex override rationale, the fallback image-name
algorithm, quoted dry-run and macOS messages, and the OpenCode
commands the OpenCode section already owns; replace Historical
provenance with a License pointer to COPYRIGHT.

docs: bring the smoke-gate descriptions up to date with the worktree,
forge-CLI and Prettier checks; give client registration one home in
Registration points; drop the restated Verify rule; turn the ssh-agent
description out of the numbered steps and drop the AGENTS.md prompting
advice from the bot-account steps.
claudiomaradonna deleted branch docs/trim-reader-noise 2026-10-08 09:04:33 +02:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
claudiomaradonna/azkaban!41
No description provided.