feat: add AI-agent redirect notices to legacy entry points - #1778
feat: add AI-agent redirect notices to legacy entry points#1778angeloashmore wants to merge 5 commits into
Conversation
@slicemachine/init, slice-machine-ui, and the four framework adapters are no longer the recommended way to set up Slice Machine. Add a short notice to each package's description, README, and startup banner (for the two runtime tools) that points AI agents at the Prismic skill and the CLI docs command.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Please simplify this PR:
npx skills add --global prismicio/skills |
Keep package.json descriptions unchanged. Move the notice from a top-of-file blockquote to the start of each package's Install section. Point the CLI banners at npx prismic init and the skill install command only, and drop the docs list reference.
|
Thanks. Two more changes, please. 1. Move the notice to the top of each README, right under the title, and fold the skill line into it. Remove the blockquote from
In 2. Banners in
Note |
Move the notice out of the Install/Quick Start sections and back under each README title. Use the full Type Builder and CLI notice everywhere. Update both process banners to match, and add --yes to the skill install command so an agent does not hang on the confirmation prompt.
|
Two more changes:
Keep the blockquote byte-identical in all ten files. In |
Put the notice as the first line, above the H1 and any logo block. Add it to the root, slice-machine, manager, and plugin-kit READMEs. The notice is byte-identical across all ten files.
|
Closing this. We will revisit the topic in a different PR. |
Resolves: N/A
Description
@slicemachine/init,slice-machine-ui, and the four framework adapters are legacy entry points. An AI agent that lands there has no way to find the currentnpx prismicpath.This adds a short notice to each package, right under the README title:
@slicemachine/init: the README and the startup banner inSliceMachineInitProcess.ts.slice-machine-ui(start-slicemachine): the README and the running-line banner inStartSliceMachineProcess.ts. Also removes a README sentence that told users to install through@slicemachine/init— it contradicted the new notice.adapter-next,adapter-nuxt,adapter-nuxt2,adapter-sveltekit: the README. These print no banner, so no runtime change is needed.The notice points to the Type Builder, the Prismic CLI docs, and the Prismic skill:
npx skills add --global --yes prismicio/skills. The--yesflag skips the confirmation prompt so an agent can run the command without hanging.package.jsondescriptions are unchanged. No existing behavior changes. This is notices only.Checklist
Preview
N/A
How to QA 1
Run
npx @slicemachine/initornpx start-slicemachineand check the startup banner. Check each package's README.Footnotes
Please use these labels when submitting a review:
⚠️ #issue: Strongly suggest a change.
❓ #ask: Ask a question.
💡 #idea: Suggest an idea.
🎉 #nice: Share a compliment. ↩