|
| 1 | +# igniteui doc-skill set · changelog |
| 2 | + |
| 3 | +## v3 · 2026-08-14 |
| 4 | + |
| 5 | +Restructures both skills to the routing-hub + references architecture used by the |
| 6 | +`IgniteUI/igniteui-angular` repo skills (SKILL.md = router with a Task → Reference table; all |
| 7 | +evolving rules live in `references/`). **No rule content changed** — v2's rules were moved, not |
| 8 | +edited; two stale cross-pointers were fixed in the move. Completes D2-03 stage 2 (physical |
| 9 | +deduplication) and adds the set-level README. Whole set bumped to v3 (uniform version line, |
| 10 | +including content-unchanged files, per the blog-creator convention). |
| 11 | + |
| 12 | +### Changed |
| 13 | + |
| 14 | +| Change | File(s) | |
| 15 | +|---|---| |
| 16 | +| igniteui-topic-frontmatter split: SKILL.md becomes a router (scope, audit-first mode, task table, hard boundaries); the field checks + severity ladder move to `references/audit-rules.md`; report shape + apply procedure move to `references/report-format.md`. `description` unchanged (adapter byte-match preserved). | igniteui-topic-frontmatter/* | |
| 17 | +| igniteui-doc-topics slimmed: SKILL.md keeps identity, two modes, compass, composite principle, task table, grounding boundaries. Create steps 1–7 (6a–6e) + the category/index structure move to `references/create-workflow.md`; the 5 audit-workflow steps move into `audit-rubric.md`. `description` unchanged. | igniteui-doc-topics/SKILL.md, references/create-workflow.md, references/audit-rubric.md | |
| 18 | +| Dedup (D2-03 stage 2): the section→mode map is no longer restated in SKILL.md — it is the "Diátaxis mode" column of house-style's canonical section table; SKILL.md keeps only the one-section-one-mode rule and the concrete mode-bleed examples. The category blueprint now lives in house-style + create-workflow only. Stale pointers fixed (house-style intro pointed at a SKILL.md map that moved; body-support bullet pointed at "Create workflow step 4" which now lives in create-workflow.md). | igniteui-doc-topics/SKILL.md, references/house-style.md | |
| 19 | +| Set-level README.md added: human-readable intent, file map, authority chain, and the five-step update procedure (edit references not routers; uniform version bump; adapter byte-match; changelog entry; resolve ‹VERIFY› by pre-committed outcome). | README.md | |
| 20 | +| Set-wide version line: every file now carries `Version: v3 · 2026-08-14 · igniteui doc-skill set`, including content-unchanged house-style and diataxis-cheatsheet (the cheatsheet gains its first version line). | all files | |
| 21 | + |
| 22 | +### Unchanged |
| 23 | + |
| 24 | +All v2 rule substance (E1–E9 with D2 amendments, D2-01…11 fixes), all open ‹VERIFY› items and their |
| 25 | +owners (see the v2 entry below), and both skill `description` fields. |
| 26 | + |
| 27 | +--- |
| 28 | + |
| 29 | +## v2 · 2026-08-14 |
| 30 | + |
| 31 | +Applies the D5 frontmatter patch v1 (E1–E9) as ratified by D2 (D2 review v1.1, 2026-08-14, transfer |
| 32 | +matrix v1 Option A) with D2's amendments, plus the D2 "do now" wave. Three wait-line items were |
| 33 | +pulled forward (D2-08, D2-09, D2-11) because the marginal cost inside a full edit pass was zero, |
| 34 | +the same precedent as blog-creator v3. Finding IDs reference the D5 review (D5-22…31, patch edits |
| 35 | +E1–E9) and the D2 review v1.1 (D2-01…12). |
| 36 | + |
| 37 | +Files changed: `igniteui-topic-frontmatter/SKILL.md`, `igniteui-doc-topics/SKILL.md`, |
| 38 | +`igniteui-doc-topics/references/house-style.md`, `igniteui-doc-topics/references/audit-rubric.md`, |
| 39 | +both `.claude/skills/*/SKILL.md` adapters. `diataxis-cheatsheet.md` is unchanged (no findings). |
| 40 | + |
| 41 | +### Applied |
| 42 | + |
| 43 | +| Finding | Change | File(s) | |
| 44 | +|---|---|---| |
| 45 | +| E1 / D5-24 + D2 amendment | Title rule split per doc set: xplat keeps `{ComponentTitle}`; Angular target `"Angular <Component> Component"` within ~60 query-relevant chars, no hand-coded suffixes pending `‹VERIFY: Angular layout title suffix behavior›`, with pre-committed outcomes for both branches (`\| Ignite UI` standardized if the layout appends nothing). Blog banned-phrase set merged in. | frontmatter SKILL.md | |
| 46 | +| E2 / D5-26 | Description bar raised: definition-first ("X is a … that …"), not imperative CTA; complete sentences; no ellipsis truncation. | frontmatter SKILL.md, house-style | |
| 47 | +| E3 / D5-23 + D2 amendment | `llms.description` defines the component, not the page: subject noun names product + component, no pronouns, no list-dumps, no page-referential phrasing; quotability test at accept time. One-definition rule added: llms.description ≈ H1 lead ≈ llms-manifest entry (`‹VERIFY: manifest source field›`). | frontmatter SKILL.md, house-style | |
| 48 | +| E4 / D5-22 | New required check: cross-field consistency (title / description / llms.description / keywords / H1 / lead sentence tell one story, same entities, same capability list). | frontmatter SKILL.md, house-style | |
| 49 | +| E5 / D5-25 | New required check: entity terminology in metadata, bound to the shared terminology table. | frontmatter SKILL.md | |
| 50 | +| E6 / D5-27 | New required check: body support for every metadata claim; frontmatter generated from the finished body. | frontmatter SKILL.md, house-style | |
| 51 | +| E7 / D5-28 | `keywords` coherence made testable: every keyword (or token-resolved form) appears in the body. | frontmatter SKILL.md | |
| 52 | +| E8 / D5-30 | `mentionedTypes` scoped: Angular occurrences tolerated, not required, pending `‹VERIFY: does the Angular pipeline consume mentionedTypes?›`. | frontmatter SKILL.md | |
| 53 | +| E9 / D5-31 | Schema linkage named in Scope: frontmatter bars are schema bars; FAQPage (if emitted) sources visible FAQ content verbatim (`‹VERIFY: schema pipeline nodes/fields›`). | frontmatter SKILL.md | |
| 54 | +| E-10 (D2 §2) | Title character budget in Severity: non-query terms pushing query terms past ~60-char truncation = Error; query-relevant portion >~60 = Warning. | frontmatter SKILL.md | |
| 55 | +| D2-01 | Contradiction fixed: reconciliation table no longer maps "Known Limitations" to Troubleshooting; drifted variants map to the required **Known Limitations** section, with the conditional Troubleshooting placement noted. | house-style | |
| 56 | +| D2-02 | Create step 4 rewritten "Write frontmatter first" → "Scaffold frontmatter": convention-fixed fields before the body; description / llms.description / keywords / mentionedTypes / relatedComponents generated from the finished body, then the frontmatter skill's cross-field and body-support checks run. Resolves the companion-skill contradiction with E6 / matrix row 11. | doc-topics SKILL.md | |
| 57 | +| D2-03 stage 1 | Single-sourcing declared: house-style "File format & frontmatter" is the normative field contract; both SKILL.mds reference it. Version lines added to all changed files; adapter `description` byte-match rule stated in both adapters and both canonicals. Shared field bars synced so no copy contradicts another. | all changed files | |
| 58 | +| D2-04 / matrix row 5 | FAQ answer shape bound: 2–4 self-contained sentences quotable without the question; fan-out question patterns (licensing, version support, migration, accessibility, "is X right for") added as authoring guidance. Rubric A11 extended. | house-style, audit-rubric | |
| 59 | +| D2-05 / matrix row 1 | Section leads name the component (and platform token): write-for-both rule 2 and rubric D3 extended. | house-style, audit-rubric | |
| 60 | +| D2-06 / matrix row 10 | Quotability test given a check ID: new D13 (H1 lead, section leads, FAQ answers, llms.description). | audit-rubric | |
| 61 | +| D2-07 / matrix row 8 | New E7: descriptive, entity-bearing anchor text on prose links; "click here"/bare URLs flagged. | audit-rubric | |
| 62 | +| D2-08 / matrix row 7 (pulled forward) | New house-style section "Entity terminology (canonical names)", a governed copy of the blog terminology table with provenance line "source: blog-creator product-context v4 · 2026-08-14". New rubric B6 for body-side entity drift. | house-style, audit-rubric | |
| 63 | +| D2-09 (pulled forward) | Table of contents added to house-style (>300-line reference, loaded on every create/audit). | house-style | |
| 64 | +| D2-10 | Routing boundary sentences added to both skill descriptions (frontmatter-only work → frontmatter skill; body/structure work → doc-topics skill). Adapters updated to byte-match. | both SKILL.mds, both adapters | |
| 65 | +| D2-11 (pulled forward) | Create step 6 split into passes 6a–6e; no rule content changed. | doc-topics SKILL.md | |
| 66 | +| Matrix row 4 (pre-commitment) | Rubric B4 carries the pending `‹VERIFY: layout H1/framework adjacency›` with both pre-committed outcomes, so the answer resolves the rule mechanically. | audit-rubric | |
| 67 | + |
| 68 | +### Deliberately not applied |
| 69 | + |
| 70 | +- **D2-03 stage 2** (physical deduplication of the field contract out of the frontmatter skill's |
| 71 | + audit rules): batched with the next structural SKILL.md edit; stage 1's authority declaration and |
| 72 | + synced wording carry the interim. |
| 73 | +- **D2-12** (verification-URL single-sourcing against RESOURCE-LIST): requires the RESOURCE-LIST |
| 74 | + canonical-variant decision, which has no owner yet. |
| 75 | +- **Canonical-link policy enforcement** (D5-29): the skill still refuses to invent canonicals; the |
| 76 | + enforcement text lands only after the policy's two `‹VERIFY›` items are answered (D2 review §5). |
| 77 | +- **Em-dash advisory** (matrix row 18): docs team's call; existing file style kept. |
| 78 | +- **Matrix rows 4 / E1 branch resolution**: `‹VERIFY›` placeholders ship in the files, as the |
| 79 | + convention intends; the pre-committed outcomes are written next to them. |
| 80 | + |
| 81 | +### Open verification items (owners) |
| 82 | + |
| 83 | +1. `‹VERIFY: Angular layout title suffix behavior›` — docs team. Resolves E1's branch and the |
| 84 | + Severity rule's application to Angular titles. |
| 85 | +2. `‹VERIFY: layout H1/framework adjacency, both doc sets›` — docs team. Resolves B4's direction. |
| 86 | +3. `‹VERIFY: schema pipeline — node types, source fields, FAQPage presence›` — docs team. |
| 87 | +4. `‹VERIFY: does the Angular pipeline consume mentionedTypes?›` — docs team. |
| 88 | +5. `‹VERIFY: llms-manifest source field›` — docs team. Resolves the one-definition rule's third leg. |
| 89 | +6. `‹VERIFY: what the layout emits when _canonicalLink is absent›` — docs team; if the answer is |
| 90 | + "nothing", it preempts every queue (D2 review §5.1). |
| 91 | +7. Canonical-link policy pattern — D2 (draft exists in D2 review §5), docs team implements. |
| 92 | + |
| 93 | +### Deploy |
| 94 | + |
| 95 | +1. Replace the four `.ai` files and two `.claude` adapters in one commit; `git diff` is the review |
| 96 | + surface. |
| 97 | +2. The adapter `description` fields must remain byte-identical to their canonicals — check on every |
| 98 | + future edit (version lines are the interim control until a CI check exists). |
| 99 | +3. Next steps per the D2 cut line: D5 step 2 diffs are superseded by this apply; skill-creator eval |
| 100 | + loop (pre-patch snapshots exist in git history) after this wave merges. |
0 commit comments