Migrate Jquery docs

.github/skills/xplat-docs-api-links/SKILL.md → .github/skills/api-link/SKILL.md

@@ -1,20 +1,25 @@
 ---
-name: xplat-docs-api-links
-description: "Reference guide for adding and fixing ApiLink and ApiRef components in xplat MDX documentation files. Covers pkg, type, kind, member, prefixed, suffix, and label props; platform prefix mapping (Igr/Igx/Igc/Igb); kind values from TypeDoc JSON; utility class suffix rules; excel library special rules (prefixed={false}, IgniteUI.Blazor.Documents.Excel); dock manager slot members; and MDX parse error from JSX in comments. Use when an agent needs to add, fix, or audit ApiLink/ApiRef calls in MDX files."
+name: api-link
+description: "Reference guide for adding and fixing ApiLink and ApiRef components in MDX documentation files. Covers all platforms: Angular, React, WebComponents, Blazor (TypeDoc URLs) and jQuery (jQueryApiUrl). Covers pkg, type, kind, member, section, prefixed, suffix, and label props; platform prefix mapping (Igr/Igx/Igc/Igb); kind values from TypeDoc JSON; utility class suffix rules; excel library special rules; dock manager slot members; jQuery widget/class URL patterns; and MDX parse error from JSX in comments. Use when an agent needs to add, fix, or audit ApiLink/ApiRef calls in MDX files."
 user-invocable: true
 ---
 
 # AI Agent Guide — Updating ApiLink & ApiRef in MDX Files
 
 ## Context
 
-The MDX files in this folder are shared across four platforms: **Angular, React, WebComponents, Blazor**. The `<ApiLink>` and `<ApiRef>` components resolve to the correct platform-specific URL at build time from a single MDX source.
+The `<ApiLink>` and `<ApiRef>` components resolve to the correct platform-specific API URL at build time.
 
-> **Key insight:** The `type=`, `member=`, `pkg=`, and `kind=` attributes are **identical for all platforms**. Fixing an ApiLink fixes it for all four platforms simultaneously. Only the generated URL differs per platform.
+- **Angular, React, WebComponents, Blazor** (`docs/angular`, `docs/xplat`) — TypeDoc URLs, resolved from hardcoded `docRoot` values in `platform-context.ts` (host swapped per environment: `staging.infragistics.com` for staging, `www.infragistics.com` for production). Steps 1–9 below apply to all four of these platforms.
+- **jQuery** (`docs/jquery`) — URL resolved from `jQueryApiUrl` in `environment.json` at build time. Different URL structure — see the **jQuery API Links** section below.
+
+**Shared MDX files** (`docs/xplat`) are built for all four TypeDoc platforms from a single source. Fixing an `<ApiLink>` there fixes it for Angular, React, WebComponents, and Blazor simultaneously.
+
+**Angular-specific MDX files** (`docs/angular`) are built only for Angular. The same `<ApiLink>` props, `pkg` keys, and `kind` rules from Steps 1–9 apply — the only difference is that there is no multi-platform concern.
 
 ---
 
-## Step 1 — Locate the API Source Data
+## Step 1 — Locate the API Source Data (xplat platforms)
 
 The `api-docs` project (sibling to this docs repository) contains TypeDoc JSON files that are the **authoritative source** for which class owns which member. Find the project by its folder name `api-docs` — the exact path on disk depends on the machine.
 Alternatively get the source from this github repository - https://github.com/IgniteUI/api-docs
@@ -60,7 +65,7 @@ Each JSON file is a TypeDoc reflection tree. Top-level `children` contains all e
 
 ---
 
-## Step 2 — Understand the MDX ApiLink Syntax
+## Step 2 — Understand the MDX ApiLink Syntax (xplat)
 
 ```mdx
 <ApiLink pkg="grids" type="TypeName" kind="class" member="memberName" prefixed={false} label="DisplayText" />
@@ -352,7 +357,96 @@ Fix: replace JSX numeric props with string values inside comments:
 
 ---
 
-## Step 8 — Fix Pattern
+## jQuery API Links
+
+jQuery docs live in `docs/jquery/` and use a completely different URL structure from the TypeDoc platforms.
+
+### How it works
+
+The jQuery build resolves `ApiLink` URLs from `jQueryApiUrl` in `docs/jquery/src/content/en/environment.json`:
+
+| Build mode | `jQueryApiUrl` |
+|---|---|
+| development | `https://www.infragistics.com/products/ignite-ui/docs/api/js` |
+| staging | `https://staging.infragistics.com/products/ignite-ui/docs/api/js` |
+| production | `https://www.infragistics.com/products/ignite-ui/docs/api/js` |
+
+Platform is identified via `docs/jquery/.platform.json` (`"platform": "jQuery"`). The build reads this file, resolves to the `jQuery` platform context, and `ApiLink.astro` uses `getEnvVars().jQueryApiUrl` as the base URL.
+
+### jQuery URL structure
+
+```
+{jQueryApiUrl}/{namespace}.{widgetName}[#{section}:{member}]
+```
+
+- **`namespace`**: `ui` for jQuery UI widgets (default), `ig` for standalone classes/datasources
+- **`widgetName`**: the widget or class name as-is (e.g. `igCombo`, `igGrid`, `igBulletGraph`, `OlapXmlaDataSource`)
+- **`section`**: `options`, `events`, or `methods` — only used when `member` is present
+- **`member`**: the specific option/event/method name
+
+### jQuery `<ApiLink>` props
+
+| Attribute | Notes |
+|---|---|
+| `type` | Widget or class name as it appears in the jQuery API URL (e.g. `"igCombo"`, `"igBulletGraph"`, `"OlapXmlaDataSource"`). No platform prefix — jQuery has none. |
+| `pkg` | `"core"` (default) → `ui.` namespace. `"ig"` → `ig.` namespace. |
+| `section` | `"options"` \| `"events"` \| `"methods"`. Required when `member` is set for the anchor to be appended. |
+| `member` | The option, event, or method name. Combined with `section` to produce `#section:member`. |
+| `label` | Override display text. Recommended — defaults to `type.member` which may not match the original link text. |
+| `kind`, `prefixed`, `suffix` | Not applicable for jQuery. Ignored. |
+
+### Examples
+
+```mdx
+import ApiLink from 'docs-template/components/mdx/ApiLink.astro';
+
+<!-- Link to a widget page -->
+<ApiLink type="igCombo" label="igCombo" />
+<!-- → https://www.infragistics.com/products/ignite-ui/docs/api/js/ui.igCombo -->
+
+<!-- Widget option -->
+<ApiLink type="igCombo" member="itemTemplate" section="options" label="itemTemplate" />
+<!-- → …/ui.igCombo#options:itemTemplate -->
+
+<!-- Widget event -->
+<ApiLink type="igCombo" member="activeItemChanged" section="events" label="activeItemChanged" />
+<!-- → …/ui.igCombo#events:activeItemChanged -->
+
+<!-- Widget method -->
+<ApiLink type="igGrid" member="dataBind" section="methods" label="dataBind" />
+<!-- → …/ui.igGrid#methods:dataBind -->
+
+<!-- ig. namespace class (datasource, non-widget) -->
+<ApiLink pkg="ig" type="OlapXmlaDataSource" label="OlapXmlaDataSource" />
+<!-- → …/ig.OlapXmlaDataSource -->
+```
+
+### Replacing `{environment:jQueryApiUrl}` tokens
+
+Old raw link in MDX:
+```mdx
+[`itemTemplate`]({environment:jQueryApiUrl}/ui.igcombo#options:itemTemplate)
+```
+
+Replacement with `<ApiLink>`:
+```mdx
+<ApiLink type="igCombo" member="itemTemplate" section="options" label="itemTemplate" />
+```
+
+Note: the old raw URLs often use all-lowercase widget names (e.g. `ui.igcombo`). The jQuery API site accepts both, but use the camelCase form in `ApiLink` `type=` for consistency (e.g. `"igCombo"` not `"igcombo"`).
+
+### Configuration files
+
+| File | Role |
+|---|---|
+| `docs/jquery/.platform.json` | Identifies the jQuery platform (`"platform": "jQuery"`) so `getPlatformContext()` returns the jQuery context |
+| `docs/jquery/src/content/en/environment.json` | Contains `jQueryApiUrl` per build mode (development / staging / production) |
+| `src/lib/platform-context.ts` | `jQuery` entry in `PLATFORMS` — `prefix: ''`, `apiPackages.core` (ui. namespace), `apiPackages.ig` (ig. namespace) |
+| `src/components/mdx/ApiLink.astro` | jQuery branch: reads `getEnvVars().jQueryApiUrl`, builds `{baseUrl}/{ns}.{type}[#{section}:{member}]` |
+
+---
+
+## Step 8 — Fix Pattern (xplat)
 
 ### Column-level fix
 
@@ -412,9 +506,11 @@ Rules:
 
 | File | Role |
 |---|---|
-| `src/components/mdx/ApiLink.astro` | ApiLink component — URL generation logic |
+| `src/components/mdx/ApiLink.astro` | ApiLink component — URL generation logic (xplat TypeDoc + jQuery) |
 | `src/components/mdx/ApiRef.astro` | ApiRef component |
-| `src/lib/platform-context.ts` | Platform config, `docRoot` URLs per platform, prefix mapping |
+| `src/lib/platform-context.ts` | Platform config, `docRoot` URLs per platform, prefix mapping, jQuery placeholder packages |
+| `docs/jquery/.platform.json` | jQuery platform identifier |
+| `docs/jquery/src/content/en/environment.json` | jQuery environment URLs including `jQueryApiUrl` |
 | `api-docs/src/data/react/igniteui-react-grids.json` | TypeDoc JSON — React grids (primary reference) |
 | `api-docs/src/data/react/igniteui-react.json` | TypeDoc JSON — React core |
 | `api-docs/src/data/angular/igniteui-angular-21.0.x.json` | TypeDoc JSON — Angular |

_imports/help-topics-ja/.gitignore

@@ -0,0 +1,3 @@
+# Trados files #
+*.sdlxliff
+*.sdlproj

_imports/help-topics-ja/README.md

@@ -0,0 +1,37 @@
+# %%ProductName%% Help Topics - Japanese
+
+### Overview
+
+This is the repository for help topics associated with [%%ProductName%%](http://jp.igniteui.com).  The help is available [online](http://jp.igniteui.com/help).
+
+The online repository is called [help-topics-ja](https://github.com/IgniteUI/help-topics-ja).  You must login to GitHub to access this page.
+
+The topics here are translated versions of the markdown files from the [help-topics](https://github.com/IgniteUI/help-topics) repository.
+
+### Branches
+
+The English help-topics branching structure is as follows.
+
++ 15.1 - The current branch.  New branches will be added with versioned names upon completion of development.
++ 14.1 - The branch that contains a snapshot of the content that was released in 14.1.  New topics from 14.2 are not merged into this branch.
++ 14.2 - The branch that contains a snapshot of the content that was released in 14.2.  It contains topics new to 14.2, but not to 15.1.
+
+### Development Branch
+
+There is a new repository for new content called [help-topics-vnext](https://github.com/IgniteUI/help-topics-vnext).  The exact methodology of working with it is still under review.  However, this needs to exist so that new content for future releases can be created without it being public.  The English [help-topics](https://github.com/IgniteUI/help-topics) repository will be going public upon the 15.1 release.  As such, if any content was added there, it would be available for anyone to view, and that's not what we want for unreleased versions.
+
+### Tools
+
+It is recommended to use [GitHub for Windows](https://windows.github.com/).
+
+The files are stored in Git, not in TFS.
+
+The files are written in [Markdown](http://daringfireball.net/projects/markdown/).
+
+For more information about Git and GitHub, please see the [Git and GitHub wiki page](http://corp.infragistics.local/departments/engineering/LocalizationTeam/Localization%20Wiki/Git%20and%20GitHub.aspx).
+
+### Questions
+
+If you have any questions about the localization process, please ask within the team.
+
+For questions about the English project, markdown, Git, or GitHub, please contact Craig Shoemaker or Damyan Petev.

docs/angular/src/content/en/components/slider/slider.mdx

@@ -392,8 +392,6 @@ This mirrors the visualization of the **ticks** and displays them above and belo
 
 <Sample src="/interactions/slider-secondary-ticks-mirror" height={160} alt="" />
 
-> [!NOTE]
->
 ### Orientation
 
 > When the <ApiLink type="Slider" member="ticksOrientation" label="ticksOrientation" /> is set to **Top** or **Mirror** and there are visible **tick labels** the **thumb label** is hidden intentionally. This prevents a bad user experience and overlapping between the two labels.

docs/jquery/.platform.json

@@ -0,0 +1,3 @@
+{
+  "platform": "jQuery"
+}

docs/jquery/astro.config.ts

@@ -0,0 +1,76 @@
+// @ts-check
+import mdx from '@astrojs/mdx';
+import path from 'node:path';
+import { createDocsSite, type DocsMode } from 'docs-template/integration';
+import { IGDOCS_PLATFORMS, type NavLang } from 'docs-template/platform';
+import { normalizeMdxDir } from 'docs-template/normalize-mdx';
+
+// ── Build mode and language ──────────────────────────────────────────────────
+// DOCS_ENV: 'development' | 'staging' | 'production'  (preferred, default: 'development')
+// NODE_ENV: fallback — do NOT set to 'staging'; Vite derives import.meta.env.DEV from it.
+// DOCS_LANG: 'en' | 'jp'                              (default: 'en')
+const docsEnv = process.env.DOCS_ENV || process.env.NODE_ENV || 'development';
+const docsLang = (process.env.DOCS_LANG || 'en') as NavLang;
+
+if (docsEnv !== 'development' && docsEnv !== 'staging' && docsEnv !== 'production') {
+	throw new Error(
+		`[astro.config] Invalid DOCS_ENV "${docsEnv}". Expected one of: "development", "staging", "production".`
+	);
+}
+
+const mode: DocsMode = docsEnv;
+
+// ── Site URL — varies by build mode ─────────────────────────────────────────
+const PROD_HOST = 'https://www.infragistics.com';
+const STAGING_HOST = 'https://staging.infragistics.com';
+
+// jp.infragistics.com is the JP domain; the base path is the same as en.
+const platformKey = docsLang === 'jp' ? 'jQueryJP' : 'jQuery';
+const { base } = IGDOCS_PLATFORMS[platformKey];
+const site = mode === 'production' ? `${PROD_HOST}${base}`
+	: mode === 'staging' ? `${STAGING_HOST}${base}`
+	: 'http://localhost:4335';
+
+// ── Source paths ─────────────────────────────────────────────────────────────
+// Japanese source files live in 'ja/' (ISO 639-1 code used by the migration
+// pipeline), while the DOCS_LANG environment value is 'jp' (matching other
+// platform conventions). All other languages use DOCS_LANG as the folder name.
+const contentLangDir = docsLang === 'jp' ? 'ja' : docsLang;
+const docsDir  = path.resolve(`./src/content/${contentLangDir}/topics`);
+const tocPath  = docsLang === 'jp'
+	? path.resolve('./src/content/toc.json')
+	: path.resolve('./toc.json');
+
+// ── Pre-process: normalize legacy DocFX MDX files to Astro/Starlight format ──
+normalizeMdxDir(docsDir);
+
+// https://astro.build/config
+export default createDocsSite({
+	site,
+	base: mode !== 'development' ? base : undefined,
+	title: 'Ignite UI for jQuery',
+	description: 'Component and API reference docs for Ignite UI for jQuery.',
+	platform: 'jquery',
+	navLang: docsLang,
+	mode,
+	productLinks: Object.values(IGDOCS_PLATFORMS)
+		.filter(p => p.lang === docsLang)
+		.map(({ label, key, base: b }) => ({
+			label,
+			href: mode === 'production' ? `${PROD_HOST}${b}` : `${STAGING_HOST}${b}`,
+			platform: key,
+		})),
+	source: {
+		tocPath,
+		docsDir,
+	},
+	starlight: {},
+	image: { service: { entrypoint: 'astro/assets/services/noop' } },
+	integrations: [mdx()],
+	// Expose @/ alias so MDX files can import components.
+	vite: {
+		resolve: {
+			alias: { '@': path.resolve('./src') },
+		},
+	},
+});

docs/jquery/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "jquery-docs",
+  "type": "module",
+  "version": "1.0.0",
+  "scripts": {
+    "dev": "astro dev --port 4335",
+    "dev:en": "cross-env DOCS_ENV=development DOCS_LANG=en astro dev --port 4335",
+    "dev:jp": "cross-env DOCS_ENV=development DOCS_LANG=jp astro dev --port 4335",
+    "build:en": "cross-env DOCS_ENV=production DOCS_LANG=en NODE_OPTIONS=--max-old-space-size=4096 astro build --outDir=../../dist/jquery",
+    "build:jp": "cross-env DOCS_ENV=production DOCS_LANG=jp NODE_OPTIONS=--max-old-space-size=4096 astro build --outDir=../../dist/jquery-jp",
+    "build": "cross-env NODE_OPTIONS=--max-old-space-size=4096 astro build",
+    "build-staging": "cross-env DOCS_ENV=staging NODE_ENV=production NODE_OPTIONS=--max-old-space-size=4096 astro build --outDir=../../dist/jquery",
+    "build-staging:en": "cross-env DOCS_ENV=staging NODE_ENV=production DOCS_LANG=en NODE_OPTIONS=--max-old-space-size=4096 astro build --outDir=../../dist/jquery",
+    "build-staging:jp": "cross-env DOCS_ENV=staging NODE_ENV=production DOCS_LANG=jp NODE_OPTIONS=--max-old-space-size=4096 astro build --outDir=../../dist/jquery-jp",
+    "build-production": "cross-env NODE_ENV=production NODE_OPTIONS=--max-old-space-size=4096 astro build --outDir=../../dist/jquery",
+    "build-production:en": "cross-env NODE_ENV=production DOCS_LANG=en NODE_OPTIONS=--max-old-space-size=4096 astro build --outDir=../../dist/jquery",
+    "build-production:jp": "cross-env NODE_ENV=production DOCS_LANG=jp NODE_OPTIONS=--max-old-space-size=4096 astro build --outDir=../../dist/jquery-jp",
+    "preview": "astro preview --outDir=../../dist/jquery --port 4335",
+    "preview:en": "cross-env DOCS_LANG=en astro preview --outDir=../../dist/jquery --port 4335",
+    "preview:jp": "cross-env DOCS_LANG=jp astro preview --outDir=../../dist/jquery-jp --port 4335",
+    "astro": "astro"
+  },
+  "engines": {
+    "node": ">=22.12.0"
+  },
+  "dependencies": {
+    "@astrojs/mdx": "^5.0.0",
+    "@astrojs/starlight": "^0.38.3",
+    "astro": "^6.1.6",
+    "docs-template": "file:../../",
+    "sharp": "^0.34.2"
+  },
+  "devDependencies": {
+    "cross-env": "^7.0.3",
+    "js-yaml": "^4.1.1",
+    "sass-embedded": "^1.98.0"
+  }
+}

docs/jquery/public/web.config

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<configuration>
+    <system.webServer>
+        <staticContent>
+            <remove fileExtension=".json" />
+            <remove fileExtension=".woff" />
+            <remove fileExtension=".woff2" />
+            <remove fileExtension=".shp" />
+            <remove fileExtension=".dbf" />
+            <remove fileExtension=".md" />
+            <mimeMap fileExtension=".json" mimeType="application/json;charset=UTF-8;" />
+            <mimeMap fileExtension=".woff" mimeType="application/font-woff" />
+            <mimeMap fileExtension=".woff2" mimeType="application/font-woff" />
+            <mimeMap fileExtension=".shp" mimeType="application/octet-stream" />
+            <mimeMap fileExtension=".dbf" mimeType="application/dbf" />
+            <mimeMap fileExtension=".md" mimeType="text/markdown;charset=UTF-8;" />
+            <!-- Pagefind binary data files -->
+            <mimeMap fileExtension=".pagefind"    mimeType="application/octet-stream" />
+            <mimeMap fileExtension=".pf_meta"     mimeType="application/octet-stream" />
+            <mimeMap fileExtension=".pf_fragment" mimeType="application/octet-stream" />
+            <mimeMap fileExtension=".pf_index"    mimeType="application/octet-stream" />
+            <mimeMap fileExtension=".pf_filter"   mimeType="application/octet-stream" />
+        </staticContent>
+        <defaultDocument>
+            <files>
+                <clear />
+                <add value="index.html" />
+            </files>
+        </defaultDocument>
+        <httpProtocol>
+            <customHeaders>
+                <add name="X-XSS-Protection" value="0" />
+            </customHeaders>
+        </httpProtocol>
+    </system.webServer>
+</configuration>

docs/jquery/src/content.config.ts

@@ -0,0 +1,6 @@
+// Zero-config content collection.
+// createDocsSite() in astro.config.ts sets DOCS_SOURCE_PATH to the absolute
+// path of src/content/en/topics before Astro starts, so the collection
+// automatically resolves to the right directory.
+import { collections } from 'docs-template/content';
+export { collections };