Repository navigation
Promote child-authored agent docs into the template (clone/degit → docs/agents/** sync) #597
Description
Summary
citynode.app authored the agent-facing docs the platform should ship to every child (PR NEARBuilders/citynode.app#431, branch docs/agent-flow-and-goals). This issue asks for a direct promotion — copy/mv the files from a clone (or degit the child repo) into the parent template, not a re-write.
Files to promote
| Child path | Lands in template |
|---|---|
docs/agents/change-placement.md |
docs/agents/change-placement.md — bug/missing-capability/pattern-improvement branches + branching-and-stacking rules; already written child-agnostic (generic account/paths, cites number-only issues) |
docs/agents/how-it-fits.md |
docs/agents/how-it-fits.md — the drawn runtime tour (authored → published → resolved → served; mounts/core-wins; generated types; .bos state table; where source lives); links need a small parent-side adjustment: it references citynode-specific docs/runtime-map.md and CONTEXT.md siblings — parameterize or generalize those two links |
docs/agents/testing.md |
docs/agents/testing.md — testing doctrine (when to test, layers, parent-coverage boundary, regression-setup fit) |
CODING_STANDARDS.md scaffold |
split: goals sections (Write code once, Type safety is the drift killer, Workarounds: ship locally upstream immediately, comment KEEP/TODO policy, deletions-first tests) become the template's standards; the CI gate flips rule stays child-owned |
Mechanism
- Clone (or
degit)citynode.app@docs/agent-flow-and-goalspost-merge. git mv/copy the four paths into the parent template'sdocs/agents/**(the AGENT_SYNC_GLOBS path), strip citynode-specific links per above.- Children inherit at the next
bos upgrade— no per-child authoring.
Relation
- everything-dev#577 (docs parity package — this is the concrete file list it described)
- everything-dev#594 (types gen owns the inventory — cited from
how-it-fits/change-placement) - everything-dev#593 (test kits —
testing.mdnames it as the future parent/child boundary) - everything-dev#596 (log retention — cited as
TODO(#596)fromhow-it-fits)
Activity
feat(docs): promote child-authored agent docs into the template (#597) (