Skip to content

feat: add AI-agent redirect notices to legacy entry points - #1778

Closed
angeloashmore wants to merge 5 commits into
mainfrom
aa/ai-agent-notices--hive-10
Closed

feat: add AI-agent redirect notices to legacy entry points#1778
angeloashmore wants to merge 5 commits into
mainfrom
aa/ai-agent-notices--hive-10

Conversation

@angeloashmore

@angeloashmore angeloashmore commented Aug 28, 2026

Copy link
Copy Markdown
Member

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 current npx prismic path.

This adds a short notice to each package, right under the README title:

  • @slicemachine/init: the README and the startup banner in SliceMachineInitProcess.ts.
  • slice-machine-ui (start-slicemachine): the README and the running-line banner in StartSliceMachineProcess.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 --yes flag skips the confirmation prompt so an agent can run the command without hanging.

package.json descriptions are unchanged. No existing behavior changes. This is notices only.

Checklist

  • If my changes require tests, I added them.
  • If my changes affect backward compatibility, it has been discussed.
  • If my changes require an update to the CONTRIBUTING.md guide, I updated it.

Preview

N/A

How to QA 1

Run npx @slicemachine/init or npx start-slicemachine and check the startup banner. Check each package's README.

Footnotes

  1. Please use these labels when submitting a review:
    ❓ #ask: Ask a question.
    💡 #idea: Suggest an idea.
    ⚠️ #issue: Strongly suggest a change.
    🎉 #nice: Share a compliment.

@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.
@vercel

vercel Bot commented Aug 28, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
slice-machine Ready Ready Preview Aug 29, 2026 3:12am

Request Review

@angeloashmore

Copy link
Copy Markdown
Member Author

Please simplify this PR:

  1. Revert all six package.json changes. Restore the original descriptions. npm metadata is not the place for this notice.

  2. READMEs: remove the blockquote at the top. Instead, add this at the start of the ## Install section (or ## Quick Start for @slicemachine/init):

    This package is no longer the recommended way to set up Prismic. Use npx prismic init instead. Using an AI agent? Teach it how to use Prismic by installing the Prismic skill:

npx skills add --global prismicio/skills

3. **Banners** in `SliceMachineInitProcess.ts` and `StartSliceMachineProcess.ts`: same two sentences, one line, no `docs list`:

   > This package is no longer the recommended way to set up Prismic. Use `npx prismic init` instead. Using an AI agent? Teach it how to use Prismic by installing the Prismic skill: `npx skills add --global prismicio/skills`

Point only to the skill: it tells the agent what to do, including where the docs are.

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.
@angeloashmore

Copy link
Copy Markdown
Member Author

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 ## Install / ## Quick Start. Use this block, verbatim, in all six READMEs:

Slice Machine is replaced by the Type Builder and the Prismic CLI. Existing projects are still supported. To move a project, see Migrate to the Type Builder.

Using an AI agent? Teach it the new way by installing the Prismic skill:

npx skills add --global --yes prismicio/skills

In packages/start-slicemachine/README.md, also delete the sentence "We recommend installing Slice Machine into your project using @slicemachine/init:" — it contradicts the notice. Keep the npx @slicemachine/init code block.

2. Banners in SliceMachineInitProcess.ts and StartSliceMachineProcess.ts, one line:

Slice Machine is replaced by the Type Builder and the Prismic CLI: https://prismic.io/docs/type-builder — AI agent? npx skills add --global --yes prismicio/skills

Note --yes: it skips the confirmation prompts so an agent can run the command without hanging. It still installs to every detected agent.

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.
@angeloashmore

Copy link
Copy Markdown
Member Author

Two more changes:

  1. Move the blockquote to the very first line of each README, above the # H1 (and above the <p align="center"> logo blocks where those come first).
  2. Add the same blockquote, also as the first line, to the READMEs not yet covered:
    • the root README.md
    • packages/slice-machine/README.md
    • packages/manager/README.md
    • packages/plugin-kit/README.md

Keep the blockquote byte-identical in all ten files. In manager and plugin-kit, place it above the existing > **Warning** block. No other changes.

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.
@angeloashmore

Copy link
Copy Markdown
Member Author

Closing this. We will revisit the topic in a different PR.

@angeloashmore
angeloashmore deleted the aa/ai-agent-notices--hive-10 branch September 4, 2026 22:47
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.

1 participant