xplat-docs-json-snippets

Guide for authoring and validating json-snippet blocks in xplat MDX: stating a component once as JSON so generation emits each platform's own code, choosing channels, keeping a platform from being stranded, and running the schema, emission, casing and live-load checks. WHEN TO USE: adding, fixing or reviewing a json-snippet fence, choosing a channel, keeping a platform from being stranded, or diagnosing a snippet schema, emission, casing or live-load failure. WHEN NOT TO USE: ApiLink markup or API term resolution (use xplat-docs-api-links), PlatformBlock on its own (use xplat-docs-platform-block), or whole-topic structure (use igniteui-doc-topics).

Jump to install Review files

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.

Install with an AI assistant

Copy this prompt into the AI assistant you're using.

Follow https://skillsmp.com/skill-install/prompt.md to install only the Agent Skill at https://github.com/IgniteUI/igniteui-documentation/tree/vnext/.claude/skills/xplat-docs-json-snippets.

A direct command skips the review prompt. Inspect the source before running it.

npx skills add https://github.com/IgniteUI/igniteui-documentation --skill xplat-docs-json-snippets

The command stays on one line. Scroll horizontally to inspect it before copying.

Prefer a local copy? Download the files currently available to SkillsMP.

Review the source files

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

SKILL.md

Source instructions · Read-only preview

name: xplat-docs-json-snippets
description: Guide for authoring and validating json-snippet blocks in xplat MDX: stating a component once as JSON so generation emits each platform's own code, choosing channels, keeping a platform from being stranded, and running the schema, emission, casing and live-load checks. WHEN TO USE: adding, fixing or reviewing a json-snippet fence, choosing a channel, keeping a platform from being stranded, or diagnosing a snippet schema, emission, casing or live-load failure. WHEN NOT TO USE: ApiLink markup or API term resolution (use xplat-docs-api-links), PlatformBlock on its own (use xplat-docs-platform-block), or whole-topic structure (use igniteui-doc-topics).

# xplat-docs-json-snippets (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-json-snippets/SKILL.md`](../../../.github/skills/xplat-docs-json-snippets/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-json-snippets/`. This pointer carries no rules. If it ever disagrees with the canonical skill, the canonical skill wins.

View on GitHub

Back to search Back to installation

igniteui-doc-topics

Authors and audits Ignite UI documentation topics - component pages, how-to guides, conceptual overviews and category indexes - across the Angular and cross-platform (React / Web Components / Blazor / WinUI / Uno) doc sets. Applies the Diataxis framework mapped onto Ignite UI house templates: canonical section order, fixed heading names, frontmatter, .mdx sample embeds, and per-framework token and PlatformBlock mechanics. WHEN TO USE: writing, reviewing, auditing, fixing or standardizing a topic, tutorial, guide, reference page or concept overview, including when the request is only "write docs for the X component"; deciding what kind of documentation a page should be; or separating a topic that mixes tutorial, how-to, reference and explanation content. WHEN NOT TO USE: frontmatter-only audits (use igniteui-topic-frontmatter), ApiLink markup (use xplat-docs-api-links), PlatformBlock alone (use xplat-docs-platform-block), or authoring a SKILL.md (use skill-authoring).

2026-10-23

igniteui-topic-frontmatter

Audits and normalizes YAML frontmatter metadata on Ignite UI MDX documentation topics: SEO titles, meta descriptions, llms.description, keywords, canonical links, relatedComponents, mentionedTypes, license and the AI-readable page identity, across the Angular and xplat doc sets. It is strictly frontmatter-only, audit-first: it reports findings and offers suggestions for the user to choose from before changing anything, and never edits topic body content, headings, prose, samples, code snippets, links, tables or section structure. WHEN TO USE: a task mentions frontmatter, SEO titles, meta descriptions, llms.description, keywords, canonical links, relatedComponents, mentionedTypes, metadata uniformity, or AI-readable page identity on a documentation topic. WHEN NOT TO USE: anything touching body content, structure, headings, prose or samples (use igniteui-doc-topics), or frontmatter on a SKILL.md rather than on a topic (use skill-authoring).

2026-10-23

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).

2026-10-22

View all from this repository

xplat-docs-json-snippets

Source facts

Install options

Install with an AI assistant

Review the source files

More from this repository

Install with an AI assistant

More from this repository