Skip to content

Release train: docs parity — AGENTS.md, GLOSSARY.md, skills #577

Open

Description

@elliotBraem

What to build: Rewrite every agent-facing passage the release train invalidates, per the cleanup inventory: AGENTS.md's pin-lifecycle paragraph ("stale pin resolves only while the 24h cache stands in") replaced with slot-first permanent resolution; the npm-publish, image-tag cadence, and "stamps the previous frameworkVersion" passages updated for the train; the changesets release-capture rule spelled out; the Dockerfile Railway claim removed. GLOSSARY.md: the platform-release-manifest and derived-pin entries gain the versioned slots + release-scoped pointer semantics. The skills (publish-sync, registry, extends-config, cli-reference, init-upgrade) get the same treatment: skip-on-registry-failure passages → hard-fail release legs; "full trains only" → "release legs"; stale-pin repair passages → old pins always resolvable; registry key layout gains platform-versions/<version>.json.

Blocked by: #573, #574, #575 …

Status: ready-for-agent

  • AGENTS.md passages rewritten (pin lifecycle, deploy/publish descriptions, changesets rules, Dockerfile removal)
  • GLOSSARY.md platform-release-manifest + derived-pin entries match the new model
  • All five skills' inventoried passages rewritten; grep for stale phrases ("skips the manifest for that deploy", "24h", "stale pin") across AGENTS/GLOSSARY/skills returns only intentional historical mentions
  • Agent-facing vocabulary includes: owed work, release leg, versioned slot, drift alarm (in-train + manual bos upgrade --check)

Activity

  1. elliotBraem commented on Oct 24, 2026

    @elliotBraem
    ContributorAuthor

    Concrete parity gaps found while aligning a child (citynode.app, PR NEARBuilders/citynode.app#428), which this release train's docs work should fold in:

    1. The child AGENTS.md is regenerated wholesale by upgrade. buildChildAgentsMd (services/scaffold) rebuilds the entire authored half from buildChildAgentsInstructions(opts), and sync rewrites it when the local hash drifts. Two consequences: template corrections to the authored half (e.g. the _layout/_authenticated auth-check sample that no composed child uses — the real shape is mounts _public/_authenticated/_admin with requireSession/requireAdmin) need a child-owned block mechanism like plugin.dev.ts's // child-owned-start, or child corrections must land in the template. Our corrections (local-vs-remote plugins, mount-based sample, runtime-map section) are in the child PR as the reference diff.
    2. Intent-skill staleness: the generated block greps as 75 skills vs 50 in skills-lock.json, and the descriptions teach retired shapes (bos.config.json — the authored descriptor is bos.app.ts; better-near-auth pinned at 1.8.2 while the platform train is on 2.0.0-rc.x). Trim + refresh the lock.
    3. The runtime map should be template content (see bos types gen should emit the composition inventory (runtime map) — typegen owns it #594): child corrections there should also move into docs/agents/** in the template so every child inherits it.
    4. A CODING_STANDARDS.md scaffold for children would give the write-once / type-safety goals a stable review-time home (currently child-local, and children each re-author it).

    Child-reference for all of the above: citynode PR #428 + docs/agents/change-placement.md.

  2. elliotBraem commented on Oct 24, 2026

    @elliotBraem
    ContributorAuthor

    Now dedicated tickets for the two concrete mechanisms described here:

    • Promotion of child-authored agent docs: everything-dev#597 (clone/degit → docs/agents/**)
    • The types:gen inventory emission (child stops hand-wiring): everything-dev#594
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    ready-for-agentFully specified, ready for an AFK agent

    Type

    No type

    Fields

    Priority

    None yet

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions