菜单
Reference guide for adding, fixing, and auditing ApiLink components in xplat MDX using the generated api-docs registry. Covers clean ApiLink props, pkg/kind disambiguation, member checks, PlatformBlock use, and registry reports.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
Author or audit Ignite UI documentation topics — component pages, how-to guides, conceptual overviews, and category indexes — for both the Angular doc set and the cross-platform (React / Web Components / Blazor) doc set. Applies the Diátaxis framework mapped onto Ignite UI's house templates: canonical section order, fixed heading names, frontmatter (including `llms.description` and the `relatedComponents` trigger), `.mdx` sample embeds, and per-framework token/PlatformBlock mechanics. Use this whenever someone asks to write, draft, create, review, audit, fix, or standardize a documentation topic, tutorial, guide, reference page, or concept overview for Ignite UI — even if they just say "write docs for the X component" or "review this topic" without naming Diátaxis or the templates. Also use it when deciding what *kind* of documentation a page should be, or when a topic mixes tutorial / how-to / reference / explanation content that should be separated.
Author or audit Ignite UI documentation topics: component pages, how-to guides, conceptual overviews, and category indexes for both the Angular doc set and the cross-platform React / Web Components / Blazor doc set. Use this whenever someone asks to write, draft, create, review, audit, fix, or standardize a documentation topic, tutorial, guide, reference page, or concept overview for Ignite UI.
Author or audit Ignite UI documentation topics: component pages, how-to guides, conceptual overviews, and category indexes for both the Angular doc set and the cross-platform React / Web Components / Blazor doc set. Use this whenever someone asks to write, draft, create, review, audit, fix, or standardize a documentation topic, tutorial, guide, reference page, or concept overview for Ignite UI.
Reference guide for syncing xplat ApiLink coverage from the legacy igniteui-xplat-docs apiMap data while keeping ApiLink markup registry-first. Use when importing missing links from igniteui-xplat-docs or auditing ApiLink coverage after API registry updates.
Guidance for using PlatformBlock in xplat MDX after ApiLink moved to registry-based resolution. Use when platform-specific prose or API symbols differ.
基于 SOC 职业分类
| name | xplat-docs-api-links |
| description | Reference guide for adding, fixing, and auditing ApiLink components in xplat MDX using the generated api-docs registry. Covers clean ApiLink props, pkg/kind disambiguation, member checks, PlatformBlock use, and registry reports. |
| user-invocable | true |
Use unprefixed TypeDoc names and let the registry resolve package, kind, prefix, suffix, URL, and member anchors:
<ApiLink type="Grid" />
<ApiLink type="Grid" member="rowSelection" />
<ApiLink type="CategoryChart" />
type: required unprefixed symbol name.member: optional member/property/method/enum value.label: optional display text.pkg: disambiguation only. Add it when check-mdx-links reports that the same symbol exists in multiple packages.kind: use for Sass (kind="sass") or when the registry report proves a TypeDoc symbol needs narrowing.Do not add exclude, excludePrefixFor, or excludeSuffixFor.
Avoid adding prefixed={false} or suffix={false} in new MDX. Those are legacy
fallback overrides, not the normal registry-based workflow.
Use PlatformBlock only when the visible content or actual API symbol differs by
platform:
<PlatformBlock for="Angular">
<ApiLink type="IGridState" />
</PlatformBlock>
<PlatformBlock for="React,WebComponents,Blazor">
<ApiLink type="GridState" />
</PlatformBlock>
Do not use PlatformBlock just to work around prefix/suffix/package URL rules.
Those should be handled by the registry or by pkg disambiguation.
Run registry checks before making manual API-link assumptions:
npm run check-mdx-links:broken:angular
npm run check-mdx-links:broken:react
npm run check-mdx-links:broken:wc
npm run check-mdx-links:broken:blazor
Interpret common statuses:
missing: the symbol was not found in the latest platform registry.member-missing: the symbol exists, but the requested member was not found.ambiguous: the symbol exists in multiple packages; add pkg.dynamic: the link uses a template value such as {ComponentName} and cannot be resolved statically.sass: Sass links are intentionally outside the TypeDoc registry.For member-missing, inspect the registry before editing. Some APIs expose
platform-specific member names, for example React dataSource versus older
source prose that says itemsSource.