Skip to content

docs: tailored README + AGENTS.md signpost (layer-nvidia) (#286) - #7

Merged
github-actions[bot] merged 1 commit into
mainfrom
feat/tailored-docs
Sep 28, 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/layer-nvidia repo. This repo gets its tailored pair:

  • README.md — user overview only. Rewritten from the generic
    candy-catalog boilerplate into a real user overview: what the layer provides
    (nvidia-container-toolkit / /usr/bin/nvidia-ctk, the per-distro driver
    packages for arch/omarchy/fedora, LD_LIBRARY_PATH=/usr/lib64, the
    /etc/vulkan/icd.d ICD wiring, no service/port; CUDA is the separate cuda
    layer), how a user consumes it (@github.com/opencharly/layer-nvidia:<tag> in a
    box candy: list; nvidia-smi / nvidia-ctk --version verification), a brief
    layout, and a pointer to the owning skill /charly-distros:nvidia.
  • AGENTS.md — new, thin, harness-neutral agent signpost. What the repo is
    and its canonical files (including CHANGELOG/); the R0 skill list
    (/charly-distros:nvidia + /charly-image:layer); the exact build/validate
    commands (charly box validate, .github/workflows/deploy.yml); the edit rule
    (change the candy entity AND its embedded skill: entity together, keep the
    Fedora signature-verification check intact, and scope distro-specific checks in
    the command itself since the runner ignores exclude-distro); and landing
    (PR-only via charly/pr-validator, 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, CHANGELOG/ and
both workflows are byte-identical to origin/main.

How tested

On the final committed head 1d7d3ec9a68c949e5f696c895de4915c6919135f:

$ git -C <cwt> status --short
(empty)

$ git -C <cwt> diff --stat origin/main..HEAD
 AGENTS.md | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 README.md | 82 ++++++++++++++++++++++++++++++++++++++++++++++++++++++----------
 2 files changed, 129 insertions(+), 13 deletions(-)

$ git -C <cwt> diff --stat origin/main..HEAD | grep -v '\.md$'
(empty — docs-only; no non-`.md` file changed)

$ /tmp/opencode/charly-238 -C <cwt> box validate     # the repo's CI-pinned charly (v2026.238.1242)
(no output; exit 0)

Cross-check with the umbrella dev binary, whose schema floor is AHEAD of this
repo's CI pin — it rejects the UNCHANGED manifest, independent of this change:

$ /home/atrawog/Sync/Atrapub/lo/opencoder/opencharly/charly/bin/charly -C <cwt> box validate
charly: error: command "validate": validation error: <cwt>/charly.yml: schema 2026.261.1747 is required (found "2026.232.0520"). Run: charly migrate

$ git -C <cwt> diff --stat origin/main..HEAD -- charly.yml
(empty — the manifest is untouched by this docs-only change, so this pre-existing
 schema-floor mismatch cannot be caused by it; the repo's own CI gate is the
 pinned `candy` workflow, which validates green above)

Rulebook compliance

Umbrella AGENTS.md rules 1–11:

  1. Never edit inside a submodule — HOW: edited only in the session worktree .worktrees/layer-nvidia-docs; 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 origin/main; base confirmed unchanged.
  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 and the dispatched skills (git-workflow, skills, layer, docs).
  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; other sessions' worktrees untouched.
  10. Before ANY update push, read the PR's live state AND write the body — HOW: initial push; the whole body is written for the head being pushed, footer last.
  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: the umbrella dev binary's box validate schema-floor mismatch was root-caused to a binary schema floor (2026.261.1747) newer than this repo's CI pin (v2026.238.1242, manifest 2026.232.0520); the diff touches no non-.md, so the mismatch is independent of this change; not parked.
  • R2 (finish the whole cutover; no parking) — HOW: the docs-only change class is delivered in full (README user overview + AGENTS signpost); the skill: entity is unchanged, so no marketplace/docs projection regeneration is triggered.
  • 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: used the repo's own charly box validate gate; no ad-hoc substitute.
  • R5 (delete legacy completely) — HOW: the generic catalog boilerplate README was replaced, not appended; no stale scaffold claim 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: ran charly box validate with the repo's CI-pinned charly on the final committed tree; output 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 source/binary.
  • R10 (fresh proof by change class) — HOW: Documentation-only change class → documentation reviewed tier; the repo's candy gate (charly box validate at the pinned charly) is the structural proof, run on the final tree.

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

Change classification

  • Change class: Documentation-only.
  • Gate: the repo's candy CI gate (charly box validate at the pinned charly) — manifest untouched, so behavior is unchanged; explicitly pasted above.
  • Attribution tier: documentation reviewed.

Refs #286

Agent: org-readme-agents · session ses_org-readme-agents
Assisted-by: opencode deepseek-v4.1-flash (documentation reviewed)

@github-actions

Copy link
Copy Markdown

Review — PASS

Head SHA: 1d7d3ec9a68c949e5f696c895de4915c6919135f (branch: feat/tailored-docs)

Security screen: PASS — no secrets/egress, no guardrail weakening, no supply-chain change; PR content is data only (T1–T4).
Checklist: All applicable rules PASS or NA.

  • Change class: docs-only (*.md only; README.md + AGENTS.md). Gate evidence box validate at the CI-pinned charly pasted (exit 0, zero warnings); tier documentation reviewed is legal for an all-doc diff and not inflated; body ends with the Agent:-then-Assisted-by: AI footer.
  • R1 disclosure (umbrella dev binary schema-floor mismatch) is a real RCA, not a flake/environmental dodge: the dev binary's floor (2026.261.1747) exceeds the repo's CI pin, and satisfying it would contradict the documented pin discipline — the manifest is intentionally pinned and untouched, so it is not a defect this PR caused or can fix. Not a B14 parking dodge.
  • B14(b)/B16: no code placement change — placement: NA (docs-only, nothing moved between core/sdk/candy).
  • Comment thread: 0 comments — nothing to disposition.

Verdict: PASS


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

View action run

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