Skip to content

docs: tailored README + AGENTS.md signpost (layer-nodejs) (#286) - #2

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/layer-nodejs repo. This repo gets its tailored pair:

  • README.md — user overview only. Rewritten into a real user overview: what the nodejs candy provides (/usr/bin/node, /usr/bin/npm, the standalone /usr/local/bin/pnpm, the npm global prefix), the NodeSource-on-Debian/Ubuntu rationale, how a user consumes it (nested candy: composition), the layout, and a pointer to the owning skill.
  • AGENTS.md — new, thin, harness-neutral agent signpost. Canonical files (charly.yml at the repo root — the env vars, the per-distro NodeSource repo arms, the pnpm download step, the check: assertions, and the embedded nodejs-skill: skill entity); the R0 skill list (/charly-coder:nodejs owning + /charly-image:layer); the exact build/validate/test statement (org-wide charly/pr-validator, validate / validate — this repo has no per-repo candy gate and ships only .github/workflows/tag-on-merge.yml); edit rules; and landing. No rule restated, no harness named.
    No functional or architecture file is touched; charly.yml and the workflow are byte-identical to origin/main.

Owning skill: /charly-coder:nodejs — this repo's embedded nodejs-skill: entity is projected into the marketplace corpus there.

How tested

On the final committed head c32e17cdffa2d6653bdbc08b16b66c53934d312c:

### layer-nodejs
$ git -C <cwt> ls-files .github/workflows
.github/workflows/tag-on-merge.yml

$ git -C <cwt> diff --stat origin/main..HEAD
 AGENTS.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 README.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++----
 2 files changed, 118 insertions(+), 4 deletions(-)

$ git -C <cwt> diff --name-only origin/main..HEAD | grep -v '\.md$' || echo '(none)'
(none)

Docs-only: every changed path is *.md; no non-.md file changed, so the
manifest and the workflow are untouched.

Rulebook compliance

Umbrella AGENTS.md rules 1–11:

  1. Never edit inside a submodule — HOW: edited only in the session worktree .worktrees/layer-nodejs-docs14; 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).
  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: no failure/warning surfaced; the manifest is untouched, so no anomaly to root-cause.
  • R2 (finish the whole cutover; no parking) — HOW: the docs-only change class is delivered in full (README user overview + AGENTS signpost); this repo carries its own embedded skill: entity, so no #291 gap applies.
  • 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 command; the change is prose only.
  • 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: the pasted evidence above is from the final committed tree; every changed path is a .md.
  • 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 R10 "documentation-only → non-runtime standards" rule); the structural proof is the docs-only diff on the final tree, pasted above.

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

Change classification

  • Change class: Documentation-only.
  • Gate: the org-wide charly/pr-validator (validate / validate); this repo has no per-repo candy gate.
  • Attribution tier: documentation reviewed.

Refs #286

Agent: layer-wave14 (subagent of org-readme-agents) · session ses_wave14_docs
Assisted-by: opencode deepseek-v4.1-flash (documentation reviewed)

@github-actions

Copy link
Copy Markdown

Review — PASS

Head SHA: c32e17cdffa2d6653bdbc08b16b66c53934d312c (branch: feat/tailored-docs)

Change class: Documentation-only (README.md modified, AGENTS.md added; every changed path is *.md, no manifest/workflow touched — confirmed by the diff and the body's pasted --name-only output).

Security screen: PASS — no secrets, no guardrail/validator/rulebook edits, no scope mismatch; diff matches the stated docs-only intent. No embedded directives (T2).

Checklist: All applicable rules PASS or NA.

  • A1 body supplies Summary, How tested (pasted docs-only diff), Attribution tier, and a full rule-by-rule compliance section (umbrella 1–11 + R1–R10), ending with the *Assisted-by: …* line last after the Agent: line.
  • A2/A3 docs-only class matches the documentation reviewed tier (legal — whole diff is docs).
  • B4–B18: docs-only; no code/candy/schema/Go/bed/gate surface applies. No parking/forbidden-framing phrases. Diffstat internally consistent (61+57=118 insertions, 4 deletions).
  • Comment thread: empty — nothing 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 03:22
@github-actions
github-actions Bot merged commit 37b3134 into main Sep 29, 2026
1 check 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