원클릭으로 Manus에서 모든 스킬 실행

xplat-docs-api-map-sync

스타6

포크0

업데이트2026년 6월 9일 13:03

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.

설치

Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.

Manus에서 실행

출처

IgniteUI

IgniteUI/igniteui-documentation

GitHub 저장소 열기 Creator 저장소 보기

다운로드

Manus에서 실행

Syncing Xplat ApiLink Coverage

Current Direction

The docs now resolve ApiLinks through the generated api-docs registry stored in src/data/api-link-index/{platform}/{staging-latest|prod-latest}.json.

The legacy igniteui-xplat-docs/apiMap files are useful for discovering missed references in old markdown, but they are not the final URL source of truth.

Rules

Prefer clean links: <ApiLink type="Grid" /> and <ApiLink type="Grid" member="rowSelection" />.
Use pkg only when the registry reports an ambiguous symbol name.
Use kind only when it is needed for Sass links or to disambiguate a real TypeDoc symbol.
Do not add exclude, excludePrefixFor, or excludeSuffixFor; those props are obsolete.
Avoid prefixed={false} and suffix={false} in new MDX. The registry should resolve the real symbol name.
Use PlatformBlock only when the prose or the actual symbol/member name differs by platform.
Never replace an existing ApiLink with backtick text only because one platform is missing it; report the miss and let the registry/API data decide.

Workflow

Use the local sibling repo ../igniteui-xplat-docs to inspect old apiMap or markdown references.
Add missing xplat ApiLinks to docs/xplat/src/content.
Run the registry checker:

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

For ambiguous results, add pkg or kind only where the report proves it is needed.
For member-missing results, first verify whether the member exists under a different name in the generated registry before changing MDX.
Keep generated reports under reports/ when they are useful for review.

Migration Helpers

docs/xplat/scripts/resolve-api-links.mjs can still be used to convert legacy backtick references into ApiLinks, but it must not emit prefix/suffix/exclude override props. Registry validation is the follow-up authority.

docs/xplat/scripts/fix-api-link-attrs.mjs may strip CLR generic arity and add kind="interface" for known apiMap/TypeDoc mismatches. It must not add prefixed={false} or suffix={false}.

이 저장소의 다른 Skills

같은 저장소

igniteui-doc-topics

IgniteUI/igniteui-documentation

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.

2026-07-176

igniteui-doc-topics

IgniteUI/igniteui-documentation

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.

2026-07-176

igniteui-doc-topics

IgniteUI/igniteui-documentation

2026-07-176

xplat-docs-api-links

IgniteUI/igniteui-documentation

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.

2026-06-096

xplat-docs-platform-block

IgniteUI/igniteui-documentation

Guidance for using PlatformBlock in xplat MDX after ApiLink moved to registry-based resolution. Use when platform-specific prose or API symbols differ.

2026-06-096

name	xplat-docs-api-map-sync
description	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.
user-invocable	true

Syncing Xplat ApiLink Coverage

Current Direction

The docs now resolve ApiLinks through the generated api-docs registry stored in src/data/api-link-index/{platform}/{staging-latest|prod-latest}.json.

The legacy igniteui-xplat-docs/apiMap files are useful for discovering missed references in old markdown, but they are not the final URL source of truth.

Rules

Prefer clean links: <ApiLink type="Grid" /> and <ApiLink type="Grid" member="rowSelection" />.
Use pkg only when the registry reports an ambiguous symbol name.
Use kind only when it is needed for Sass links or to disambiguate a real TypeDoc symbol.
Do not add exclude, excludePrefixFor, or excludeSuffixFor; those props are obsolete.
Avoid prefixed={false} and suffix={false} in new MDX. The registry should resolve the real symbol name.
Use PlatformBlock only when the prose or the actual symbol/member name differs by platform.
Never replace an existing ApiLink with backtick text only because one platform is missing it; report the miss and let the registry/API data decide.

Workflow

Use the local sibling repo ../igniteui-xplat-docs to inspect old apiMap or markdown references.
Add missing xplat ApiLinks to docs/xplat/src/content.
Run the registry checker:

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

For ambiguous results, add pkg or kind only where the report proves it is needed.
For member-missing results, first verify whether the member exists under a different name in the generated registry before changing MDX.
Keep generated reports under reports/ when they are useful for review.

Migration Helpers

docs/xplat/scripts/fix-api-link-attrs.mjs may strip CLR generic arity and add kind="interface" for known apiMap/TypeDoc mismatches. It must not add prefixed={false} or suffix={false}.