Skip to main content

xplat-docs-api-links

Reference guide for authoring and auditing API terms in the multi-platform docs tree. Strict-xplat topics require canonical backticked terms; other populations may use raw ApiLink components. Covers the platformType populations, the apiTerms modes, raw ApiLink props, and pkg/kind disambiguation. WHEN TO USE: adding, fixing or auditing an ApiLink or a backticked API term in xplat MDX, deciding how a page's platformType or apiTerms affects its names, or resolving a check-mdx-links ambiguity report. WHEN NOT TO USE: PlatformBlock on its own (use xplat-docs-platform-block), json-snippet blocks (use xplat-docs-json-snippets), whole-topic structure (use igniteui-doc-topics), or MDX topic frontmatter (use igniteui-topic-frontmatter).

Source facts

Repository
IgniteUI/igniteui-documentation
Last source activity
October 20, 2026 at 14:01
Detected SKILL.md language
English
Stars
6
Forks
1

Install options

The review-first prompt is selected by default. You can switch to a direct command or download a local copy.

Review the source files

Read SKILL.md and any companion files shown by SkillsMP before deciding whether to install.

Showing SKILL.md

SKILL.md
Source instructions · Read-only preview
name
xplat-docs-api-links
description
Reference guide for authoring and auditing API terms in the multi-platform docs tree. Strict-xplat topics require canonical backticked terms; other populations may use raw ApiLink components. Covers the platformType populations, the apiTerms modes, raw ApiLink props, and pkg/kind disambiguation. WHEN TO USE: adding, fixing or auditing an ApiLink or a backticked API term in xplat MDX, deciding how a page's platformType or apiTerms affects its names, or resolving a check-mdx-links ambiguity report. WHEN NOT TO USE: PlatformBlock on its own (use xplat-docs-platform-block), json-snippet blocks (use xplat-docs-json-snippets), whole-topic structure (use igniteui-doc-topics), or MDX topic frontmatter (use igniteui-topic-frontmatter).
# xplat-docs-api-links (pointer) Generated by `scripts/sync-agent-skills.mjs`. Do not edit. Claude Code discovers project skills only from `.claude/skills/`, so this file exposes the skill there. The source of truth is [`.github/skills/xplat-docs-api-links/SKILL.md`](../../../.github/skills/xplat-docs-api-links/SKILL.md) — read it and follow it as your complete instructions before taking any action. Resolve every reference path in the canonical skill relative to its own directory, `.github/skills/xplat-docs-api-links/`. This pointer carries no rules. If it ever disagrees with the canonical skill, the canonical skill wins.
View on GitHub