Skip to content

docs: add frontmatter audit skill and refine topic guidelines#455

Open
IMinchev64 wants to merge 5 commits into
vnextfrom
iminchev/skill-update
Open

docs: add frontmatter audit skill and refine topic guidelines#455
IMinchev64 wants to merge 5 commits into
vnextfrom
iminchev/skill-update

Conversation

@IMinchev64

Copy link
Copy Markdown
Contributor

Closes #

Checklist:

  • check topic's TOC/menu and paragraph headings
  • Include TOC topic labels in the topic content when it has a valuable update, is new, or is considered preview / beta
  • link to other topics using ./page.mdx or ../relative/path.mdx (.mdx extension required)
  • at the References section at the end of the topic add links to topics, samples, etc
  • reference API documentation instead of adding a section with API

  • use valid component names - [Data] Grid, IgxSelectComponent, <igx-combo>
  • use spell checker tool (VS Code, Grammarly, Microsoft Editor)
  • add inline code blocks for the names of classes / tags / properties
  • add language descriptor for the code blocks
  • check if links function by running the check-api/mdx npm commands
  • check if sample is working and fully visible in the topic
  • check if sample is working and fully visible in the StackBlitz
  • check if code blocks match the code in StackBlitz demo
  • add or update meaningful llms.description metadata and run npm run check:llms-metadata


  • do not resolve requested changes (leave that to the reviewer)

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new dedicated skill for auditing/normalizing MDX YAML frontmatter, and updates the existing Ignite UI doc-topic authoring/audit guidance to incorporate Indigo.Design structure cues and new required section/asset expectations (e.g., ## Live Demo, Do/Don’t guidance image).

Changes:

  • Introduces igniteui-topic-frontmatter as a canonical .ai skill plus Codex/Claude adapters.
  • Refines igniteui-doc-topics workflow guidance to incorporate Indigo.Design structure mapping and explicit ## Live Demo requirements.
  • Updates the house style and audit rubric to codify the ## Live Demo section contract and Do/Don’t guidance-image expectation.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
.codex/skills/igniteui-topic-frontmatter/SKILL.md Adds Codex adapter pointing to the canonical frontmatter skill.
.claude/skills/igniteui-topic-frontmatter/SKILL.md Adds Claude adapter pointing to the canonical frontmatter skill.
.ai/skills/igniteui-topic-frontmatter/SKILL.md Adds the canonical frontmatter-only audit skill definition and rules.
.ai/skills/igniteui-doc-topics/SKILL.md Updates author/audit workflow guidance (Indigo.Design mapping, Live Demo requirement, frontmatter-skill pointer).
.ai/skills/igniteui-doc-topics/references/house-style.md Updates house style (imports, section order, Do/Don’t image guidance, Live Demo contract, Indigo.Design suggestions).
.ai/skills/igniteui-doc-topics/references/audit-rubric.md Updates audit checks for ## Live Demo, Do/Don’t image/TODO requirement, and Indigo.Design-driven Usage opportunities.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .ai/skills/igniteui-doc-topics/references/house-style.md Outdated
and **When not to use:** labels rather than nested headings, plus the matching guidance image
from the Indigo.Design documentation or a `{/* TODO */}` marker when the asset is not available.
Add a required `## Live Demo` section
with exactly one top `<Sample>`, then Usage samples only for distinct tasks (soft max 5/page).
@Hristo313 Hristo313 self-assigned this Jul 22, 2026
@Hristo313
Hristo313 self-requested a review July 22, 2026 11:15
@Hristo313 Hristo313 added the 💥 status: in-test PRs currently being tested label Jul 22, 2026
@Hristo313 Hristo313 added ✅ status: verified Applies to PRs that have passed manual verification and removed 💥 status: in-test PRs currently being tested labels Jul 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc-redesign ✅ status: verified Applies to PRs that have passed manual verification

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants