Skip to content

docs: tailored README + AGENTS.md signpost (plugin-jetkvm) (#286) - #13

Merged
github-actions[bot] merged 1 commit into
mainfrom
feat/tailored-docs
Sep 29, 2026
Merged

github-actions[bot] merged 1 commit into
mainfrom
feat/tailored-docs

Conversation

@aitrawog

Copy link
Copy Markdown
Contributor

Summary

Docs-only leg of umbrella campaign opencharly/opencharly#286 for the
opencharly/plugin-jetkvm repo. This plugin repo gets its tailored pair:

  • README.md — user overview only. Rewritten from the generic
    candy-catalog boilerplate into a real user overview of the plugin:
    what it provides (the jetkvm: check/control verb + the kind: jetkvm device entity, driven out-of-process over JetKVM's own WebRTC control plane), the read-only-by-default safety gate, the method catalog, the console-installer OCR path, how a user consumes it (@github.com/opencharly/plugin-jetkvm/candy/plugin-jetkvm:<tag> in a box/check-bed candy: list), the repo's own disposable beds, a brief layout, and a pointer to the owning skill.
  • AGENTS.md — new, thin, harness-neutral agent signpost. What the repo is
    and its canonical files; the R0 skill list; the build/validate/test section
    (go build ./..., go test ./..., charly box validate locally; no
    per-repo candy gate
    ; the org merge gate is charly/pr-validator); the edit
    rule; and landing (PR-only, history in CHANGELOG/, authoritative rulebook is
    the umbrella AGENTS.md + charly/AGENTS.md). It restates no rule and names
    no harness.

No functional or architecture file is touched; charly.yml, the Go source, the
schemas, and the workflow are byte-identical to origin/main.

How tested

On the final committed head 4f1179e2f8a06fe7888b1a381a16514896fddcd8:

$ git -C /home/atrawog/Sync/Atrapub/lo/opencoder/opencharly/.worktrees/plugin-jetkvm-pdocs6 ls-files .github/workflows
.github/workflows/ci.yml
.github/workflows/tag-on-merge.yml

$ git -C /home/atrawog/Sync/Atrapub/lo/opencoder/opencharly/.worktrees/plugin-jetkvm-pdocs6 diff --stat origin/main..HEAD
 AGENTS.md | 65 ++++++++++++++++++++++++++++++++++++++++++++++
 README.md | 89 +++++++++++++++++++++++++++++++++++++++++++--------------------
 2 files changed, 126 insertions(+), 28 deletions(-)

$ git -C /home/atrawog/Sync/Atrapub/lo/opencoder/opencharly/.worktrees/plugin-jetkvm-pdocs6 diff --name-only origin/main..HEAD | grep -v '\.md$' || echo '(none)'
(none)

The repo carries no per-repo candy gate — its workflow file(s) are listed
above. The merge gate is the org-wide charly/pr-validator (required check
validate / validate, defined in opencharly/.github). charly box validate
is not run as the gate here: it is blocked org-wide by the in-flight
schema-versioning transition and is NOT the gate for a docs-only change.

Rulebook compliance

Umbrella AGENTS.md rules 1–11:

  1. Never edit inside a submodule — HOW: edited only in the session worktree plugin-jetkvm-pdocs6; the tracked submodule checkout stays clean/detached.
  2. Git op rule (git -C <abs>) — HOW: every git/gh action ran via git -C <absolute-path> / --repo.
  3. No nested go.work — N/A — no Go workspace file touched.
  4. Sessions root at the umbrella; edits in a session worktree off fresh origin/main — HOW: worktree branched off fresh origin/main; base confirmed unchanged (behind=0).
  5. Pin discipline (merged refs only) — N/A — no pin/gitlink changed.
  6. Policy B (distro pins == charly gitlinks) — N/A — no submodule gitlink touched.
  7. Read the subrepo's own rulebook first — HOW: read the umbrella AGENTS.md, charly/AGENTS.md, and the dispatched skills (git-workflow, skills, plugin) from upstream origin/main.
  8. Harness config: shared core + deliberate forks — N/A — no harness config changed.
  9. Session-scoped ownership — HOW: only this session's worktree/branch/PR touched; no pre-existing <r>-docs* worktree or branch exists for this repo, and none was created.
  10. Before ANY update push, read the PR's live state AND write the body — HOW: body written for the head at PR-open; no update push yet.
  11. Agent identity & comment coordination footer (extends rule 9) — HOW: two-line Agent:-then-Assisted-by: footer in canonical order; solo/uncontended scope.

Ground-truth rules R1–R10 (charly/AGENTS.md):

  • R1 (RCA every anomaly) — HOW: no anomaly surfaced in the docs-only change; the diff lists only .md files (pasted above).
  • R2 (finish the whole cutover; no parking) — HOW: the docs-only pair is delivered in full; the plugin entity and Go source are unchanged, so no marketplace/docs projection regeneration is triggered. The candy's owning-skill disposition is stated in the README + AGENTS.md.
  • R3 (no duplication) — HOW: README points at the owning skill instead of restating it; AGENTS points at the rulebook instead of restating rules.
  • R4 (no workarounds) — HOW: no ad-hoc substitute; the docs-only class is gated on the non-runtime standards (diff class + real file listing).
  • R5 (delete legacy completely) — HOW: the stale generic boilerplate README was replaced, not appended; no retired reference remains.
  • R6 (git safety) — HOW: status inspected before/after; no force-push, no hook bypass, no direct push to main; no other session's work touched.
  • R7 (prove the gate, not the plan) — HOW: the real file listing and diff-stat on the final committed tree are pasted above.
  • R8 (preserve emitted artifacts) — N/A — docs-only; no emitted artifact/config changed.
  • R9 (binary equals source) — N/A — this repo ships no charly binary; the plugin module is unchanged.
  • R10 (fresh proof by change class) — HOW: Documentation-only change class → documentation reviewed tier; no invented bed (per charly/AGENTS.md R10: "Documentation-only changes run every non-runtime standard and no invented bed").

RDD / ADE / SDD — N/A — documentation-only.

Change classification

  • Change class: Documentation-only.
  • Gate: the non-runtime standards — the diff is entirely *.md (pasted above); charly.yml, the Go source, and the workflow are untouched, so behavior is unchanged.
  • Attribution tier: documentation reviewed.

Owning skill: /charly-check:jetkvm

Refs #286

Agent: plugin-wave6 (subagent of org-readme-agents) · session ses_pluginwave6
Assisted-by: opencode deepseek-v4.1-flash (documentation reviewed)

Assisted-by: opencode deepseek-v4.1-flash (documentation reviewed)
@github-actions

Copy link
Copy Markdown

Review — PASS

Head SHA: 4f1179e2f8a06fe7888b1a381a16514896fddcd8 (branch: feat/tailored-docs)

Security screen: PASS — no directive aimed at the reviewer (T2), no scope mismatch, no secrets/egress/supply-chain edits, no guardrail or rulebook weakening; the new subrepo AGENTS.md defers to main's umbrella rulebook rather than redefining it (T1/T4).
Checklist: All applicable rules PASS or NA. Change class is genuinely documentation-only (both changed files are *.md; pasted git diff --name-only … | grep -v '\.md$' = (none)), so the documentation reviewed tier is legal (A3) and no bed/rebuild is required (A2/B12). Body is template-complete, accounts for both files, and ends with the required Agent:-then-Assisted-by: footer (A1). The pasted git diff --stat (AGENTS.md 65, README.md 89 = 61+28; 126 insertions / 28 deletions) reconciles exactly with the file diffs. No failure/warning, no parking/dodge framing, no duplication or workaround, one atomic commit (R1/R2/R3/R4/R5/R10, B5–B15). No comments on the thread to disposition.

Verdict: PASS


ollama-cloud/deepseek-v4.1-flash — action-review.

View action run

@github-actions
github-actions Bot enabled auto-merge (squash) September 29, 2026 02:35
@github-actions
github-actions Bot merged commit 9a94d86 into main Sep 29, 2026
2 checks passed
charly-auto-merge Bot added a commit that referenced this pull request Sep 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants