bcquality/community/knowledge/appsource/keep-copilot-help-url-to-two-path-levels.md
Jeremy Vyska f5156c61de Add 15 community knowledge articles from BC Code Intel ingest
Ingests net-new /community knowledge from BC Code Intelligence, surviving
the admission test, gray-zone salvage, and dedup against the full corpus.

Domains: ui (6), error-handling (3), performance (2), upgrade (1),
appsource (1), security (1), telemetry (1). The two BC24 No. Series
migration drafts are merged into one article.

Adds good/bad AL samples for the clean-fit articles (error-handling,
performance, security, telemetry). UI and appsource remain knowledge-only.

Validator and knowledge-index checks pass (207 articles).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-01 11:02:48 +02:00

1.5 KiB

bc-version domain keywords technologies countries application-area
24..
appsource
app-json
help-url
copilot
grounding
documentation
url-depth
contexturl
al
w1
all

Keep the Copilot help URL to two path levels

Contributions welcome — open a PR to refine or extend this article.

Description

The help URL declared in app.json is what Copilot uses to ground answers about your app. That URL may be at most two path levels deep (for example https://contoso.com/docs/myapp). If you point it at a deeper path (three or more segments), Copilot does not use the URL as given: it truncates to the first two levels, drops any fragments and query strings, and then grounds on all content beneath that two-level path. The failure is silent — there is no build error — and the practical effect is worse answers, because Copilot may ingest sibling apps' documentation that lives under the same two-level parent.

Best Practice

Organize per-app documentation so the canonical help page sits no deeper than two path levels, and confirm during testing that Copilot citations resolve to your app's content rather than a broader parent. If your docs naturally nest deeper, give each app a dedicated two-level path it owns.

Anti Pattern

Setting help to a deep, tidy-looking docs path such as https://contoso.com/docs/products/erp/myapp/setup. Copilot truncates it to …/docs/products, then grounds on everything under that node — pulling in unrelated content and degrading answer quality for your users.