Skip to content

create-objectstack: the blank template's README still cites ADR-0097 and "the ObjectStack framework repo" — the last two dead references in a scaffolded project #11022

Description

@os-elon

Found during the in-scope template sweep for #10324, and deliberately not fixed there: that card's dispatch fenced packages/create-objectstack/src/templates/blank/README.md out because #10322 had an open PR (#11013) over the same file.

The residue, measured on a real scaffold

Built the CLI from #10324's branch and ran it for real (node dist/index.js acme-notes -t blank --skip-install --skip-skills), then swept the generated project — not the template source — for references a reader with only their own project cannot follow. After #10324's fix, exactly two remain, both in README.md:

README.md:77 boot (ADR-0097); a flow's `connector_action` node then calls it. To add a brand
README.md:134 Skills live in `skills/` in the ObjectStack framework repo and in the in-IDE

:77 is the same ADR identifier #10324 removed from objectstack.config.ts two files over — a scaffolded project ships no docs/adr/, so it reads as a reference the newcomer is failing to follow. :134 points at a directory in this monorepo; the scaffolder's own closing output already names the followable form (npx skills add objectstack-ai/objectstack/skills).

Checked and not a defect: README.md:102's See `AGENTS.md` for the full convention — the scaffolder really does write AGENTS.md into the target project (src/index.ts, writeIfAbsent(path.join(targetDir, 'AGENTS.md'), rendered)), so that pointer resolves.

Why it is a genuine leftover rather than a duplicate

PR #11013's diff touches README.md in one hunk near the top (adding a validate sentence to "Getting started"); it does not reach line 77 or line 134. So no card in the #10264 family covers these two lines: #10990 owns the host-convergence lines in AGENTS.md / Dockerfile / docker-compose.yml, and #10324 was fenced out of this file.

Suggested landing

Rewrite both self-contained in the style #10324 settled on — state the fact, and link a public page rather than an internal identifier. https://objectstack.ai/docs/automation/connectors covers the ADR-0097 material (verified resolvable against content/docs).

One extra step when this lands:#10324 added packages/create-objectstack/src/starter-comments-self-contained.test.ts, which scans every shipped template file for exactly this pattern and carries a self-retiringEXCLUDED entry for this README. Once these two lines are gone, that test fails on purpose, telling you to delete the entry so the README is scanned like every other shipped file. Deleting the entry is part of the fix, not a follow-up.

Filed by the os-dev seat working #10324; reported rather than fixed because the file was fenced out of that dispatch.

Metadata

Metadata

Assignees

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions