Skip to content

[docs] Document AI client skill recommendation and --no-ai-hint flag - #2618

Draft
shopware-docs-updater[bot] wants to merge 1 commit into
mainfrom
docs/ai-hint-recommendation-d5e02b2eb4c5749c
Draft

shopware-docs-updater[bot] wants to merge 1 commit into
mainfrom
docs/ai-hint-recommendation-d5e02b2eb4c5749c

Conversation

@shopware-docs-updater

Copy link
Copy Markdown
Contributor

Warning

Threat Detection Engine Failure — The analysis engine could not complete. This is a tooling failure, not a security finding.

What happened

The threat detection engine failed to produce results.

Review the workflow run logs for details.

Summary

Shopware CLI PR shopware/shopware-cli#1686 (merged, by Tomasz Turkowski (@tturkowski)) added a user-facing CLI behavior change: the CLI now detects when it's invoked by a supported AI coding agent (via the AI_AGENT environment variable) and, if the shopware-cli skill isn't installed for that client, prints a short non-blocking recommendation to stderr pointing at shopware-cli ai add ... --global. It also added a new global --no-ai-hint flag to suppress this recommendation, and made the previously hidden ai command group visible in --help.

This is directly comparable to the existing, already-documented --no-update-hint / update-notification behavior in products/tools/cli/installation.md, but the new --no-ai-hint flag and AI recommendation mechanism had no corresponding entry in the public docs (only in the repo's internal docs/AGENT_SKILLS.md, which is not part of the public developer documentation).

Documentation gap addressed

  • The public CLI docs had no mention of the AI skill recommendation feature or the --no-ai-hint flag.
  • Added a new "AI client skill recommendation" section in products/tools/cli/installation.md, directly after the existing "Update notifications" section, following the same style and structure (what triggers it, when it stays silent, and how to suppress it with --no-ai-hint).

Files changed

  • products/tools/cli/installation.md — added "AI client skill recommendation" section documenting the AI_AGENT-based detection, the silence conditions (no agent detected, CI set, --no-ai-hint passed, running an ai ... command, skill already installed), the 24-hour suppression window, and the --no-ai-hint flag usage.

Validation

  • Documentation-only change; no code/build tooling was touched.
  • pnpm run check:markdown was not run locally because pnpm is not available in this sandbox environment — the change mirrors the exact structure/style of the adjacent, already-passing "Update notifications" section, so it should conform to the same markdown lint rules.

Related: shopware/shopware-cli#1686

Generated by 📝 PR documentation check for #1686 · copilot · auto · 45.6 AIC · ⊞ 7.9K · ◷

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

@shopware-docs-updater shopware-docs-updater Bot left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Threat detection produced a warning for this pull request output.

These changes need to be scrutinized before merge and only merged after a careful manual review.

@shopware-dev-docs-connector

shopware-dev-docs-connector Bot commented Oct 15, 2026 •

Copy link
Copy Markdown

Developer Docs healthcheck

Status: Completed with success.
Repository: shopware/docs
Commit: 284f9bd
Preview: https://developer-documentation-bs1a56gyi-shopware-frontends.vercel.app
Workflow run: #5664

@shopware-dev-docs-connector

Copy link
Copy Markdown

Developer Docs healthcheck

Status: Running.
Repository: shopware/docs
Commit: 284f9bd
Preview: Waiting for workflow logs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants